console_kit 1.0.0 → 1.2.0

data/lib/console_kit/prompt.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ConsoleKit
+  # Sets the console prompt to show the current tenant
+  module Prompt
+    class << self
+      def apply
+        apply_irb_prompt if defined?(IRB)
+        apply_pry_prompt if defined?(Pry)
+      end
+
+      private
+
+      def tenant_label
+        tenant = ConsoleKit::Setup.current_tenant
+        tenant ? "[#{tenant}]" : '[no-tenant]'
+      end
+
+      def apply_irb_prompt
+        conf = IRB.conf
+        prompt = conf[:PROMPT] ||= {}
+        prompt[:CONSOLE_KIT] = {
+          PROMPT_I: "#{tenant_label} %N(%m):%03n> ",
+          PROMPT_S: "#{tenant_label} %N(%m):%03n%l ",
+          PROMPT_C: "#{tenant_label} %N(%m):%03n* ",
+          RETURN: "=> %s\n"
+        }
+        conf[:PROMPT_MODE] = :CONSOLE_KIT
+      end
+
+      def apply_pry_prompt
+        procs = pry_prompt_procs(tenant_label)
+        Pry.config.prompt = build_pry_prompt(procs)
+      end
+
+      def pry_prompt_procs(label)
+        [
+          proc { |obj, nest, _| "#{label} (#{obj}):#{nest}> " },
+          proc { |obj, nest, _| "#{label} (#{obj}):#{nest}* " }
+        ]
+      end
+
+      def build_pry_prompt(procs)
+        if defined?(Pry::Prompt) && Pry::Prompt.respond_to?(:new)
+          Pry::Prompt.new('console_kit', 'ConsoleKit tenant prompt', procs)
+        else
+          procs
+        end
+      end
+    end
+  end
+end

data/lib/console_kit/railtie.rb

@@ -3,7 +3,15 @@
 module ConsoleKit
   # Railtie for integrating ConsoleKit with Rails console.
   class Railtie < Rails::Railtie
-    console { ConsoleKit::Setup.setup }
+    console do
+      ConsoleKit::Setup.setup
+      ConsoleKit::Prompt.apply
+      if defined?(IRB::ExtendCommandBundle) && !defined?(Pry)
+        IRB::ExtendCommandBundle.include(ConsoleKit::ConsoleHelpers)
+      else
+        TOPLEVEL_BINDING.receiver.extend(ConsoleKit::ConsoleHelpers)
+      end
+    end
 
     config.to_prepare { ConsoleKit::Setup.reapply if defined?(Rails::Console) }
   end

data/lib/console_kit/setup.rb

@@ -3,6 +3,7 @@
 require_relative 'tenant_selector'
 require_relative 'tenant_configurator'
 require_relative 'output'
+require_relative 'setup_ui'
 
 # Core Logic for initial Setup
 module ConsoleKit
@@ -27,20 +28,26 @@ module ConsoleKit
       def reset_current_tenant
         return warn_no_tenants unless tenants?
 
-        warn_reset if current_tenant
-        TenantConfigurator.clear if current_tenant
-
-        self.current_tenant = nil
-        setup
+        perform_tenant_reset
       end
 
       private
 
+      def perform_tenant_reset
+        key = select_tenant_key
+        return cancel_switch if key == :abort || key.blank?
+
+        clear_current_tenant
+        return skip_tenant_message if %i[exit none].include?(key)
+
+        configure(key)
+      end
+
       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)
@@ -54,19 +61,13 @@ module ConsoleKit
       end
 
       def handle_selection_result(key)
-        exit_on_key(key) if key == :exit
+        exit_on_key if %i[exit abort].include?(key)
 
-        case key
-        when :abort, :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(key)
-        return unless key == :exit
-
+      def exit_on_key
         Output.print_info('Exiting console...')
         Kernel.exit
       end
@@ -76,19 +77,25 @@ module ConsoleKit
         return unless TenantConfigurator.configuration_success
 
         self.current_tenant = key
-        Output.print_success("Tenant initialized: #{key}")
+        Prompt.apply
+        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
+          Output.print_warning("Resetting tenant: #{current_tenant}")
+          TenantConfigurator.clear
+        end
+        self.current_tenant = nil
+      end
 
       def handle_error(error)
         Output.print_error("Error setting up tenant: #{error.message}")

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,11 +2,19 @@
 
 require_relative 'output'
 require_relative 'connections/connection_manager'
+require_relative 'connections/dashboard'
 
 module ConsoleKit
   # For tenant configuration
   module TenantConfigurator
     class << self
+      HANDLER_ATTRIBUTES = {
+        Connections::SqlConnectionHandler => :tenant_shard,
+        Connections::MongoConnectionHandler => :tenant_mongo_db,
+        Connections::RedisConnectionHandler => :tenant_redis_db,
+        Connections::ElasticsearchConnectionHandler => :tenant_elasticsearch_prefix
+      }.freeze
+
       def configuration_success = Thread.current[:console_kit_configuration_success]
 
       def configuration_success=(val)
@@ -39,7 +47,7 @@ module ConsoleKit
       end
 
       def reset_context_attributes(ctx)
-        %i[tenant_shard tenant_mongo_db partner_identifier].each do |attr|
+        available_context_attributes(ctx).each do |attr|
           ctx.public_send("#{attr}=", nil)
         end
       end
@@ -60,31 +68,41 @@ module ConsoleKit
         configure_success(key)
       end
 
-      def validate_context_interface!(ctx)
-        missing = required_interface_methods.reject { |s| ctx.respond_to?(s) }
-        return if missing.empty?
-
-        raise Error, "Context class #{ctx} does not implement the required interface. " \
-                     "Missing methods: #{missing.join(', ')}"
+      def handler_available?(handler_class)
+        handler_class.new(nil).available?
+      rescue NotImplementedError, StandardError
+        false
       end
 
-      def required_interface_methods
-        attributes = %i[tenant_shard tenant_mongo_db partner_identifier]
-        attributes + attributes.map { |a| "#{a}=" }
+      def available_context_attributes(ctx)
+        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
       end
 
       def apply_context(constant)
         ctx = ConsoleKit.configuration.context_class
-        validate_context_interface!(ctx)
-
         assign_context_attributes(ctx, constant)
         setup_connections(ctx)
       end
 
       def assign_context_attributes(ctx, constant)
-        ctx.tenant_shard = constant[:shard]
-        ctx.tenant_mongo_db = constant[:mongo_db]
-        ctx.partner_identifier = constant[:partner_code]
+        attribute_to_constant = {
+          partner_identifier: :partner_code,
+          tenant_shard: :shard,
+          tenant_mongo_db: :mongo_db,
+          tenant_redis_db: :redis_db,
+          tenant_elasticsearch_prefix: :elasticsearch_prefix
+        }
+
+        available_context_attributes(ctx).each do |attr|
+          ctx.public_send("#{attr}=", constant[attribute_to_constant[attr]])
+        end
       end
 
       def setup_connections(context)

data/lib/console_kit/tenant_selector.rb

@@ -9,36 +9,40 @@ module ConsoleKit
     DEFAULT_SELECTION = '1'
 
     class << self
-      def select = attempt_selection(RETRY_LIMIT)
+      def select
+        RETRY_LIMIT.times do
+          result = attempt_selection
+          return result unless result == :retry
+        end
+        nil
+      end
 
       private
 
-      def attempt_selection(retries_left)
-        return nil if retries_left.zero?
-
+      def attempt_selection
         print_tenant_selection_menu
-        process_selection(retries_left)
+        process_selection(parse_user_selection)
       end
 
-      def process_selection(retries_left)
-        selection = parse_user_selection
-        return :abort if selection == :abort
-        return attempt_selection(retries_left - 1) unless selection
+      def process_selection(selection)
+        return :retry unless selection
+        return selection if selection == :abort
 
         selection.is_a?(Integer) ? resolve_selection(selection) : selection
       end
 
       def print_tenant_selection_menu
         Output.print_header('Multiple tenants detected. Please choose one:')
+        Output.print_list(menu_items)
+      end
 
-        items = []
-        items << '0. Skip (load without tenant configuration)'
-
-        ConsoleKit.tenants.keys.each_with_index do |key, index|
+      def menu_items
+        tenants = ConsoleKit.tenants.keys
+        items = ['0. Skip (load without tenant configuration)']
+        tenants.each_with_index.map do |key, index|
           items << "#{index + 1}. #{key} (partner: #{tenant_partner(key)})"
         end
-
-        Output.print_list(items)
+        items
       end
 
       def tenant_partner(key) = ConsoleKit.tenants.dig(key, :constants, :partner_code) || 'N/A'
@@ -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.")
@@ -69,9 +73,10 @@ module ConsoleKit
 
       def read_input_with_default
         Output.print_prompt("Selection (number or name) [#{DEFAULT_SELECTION}]: ")
-
         raw_input = $stdin.gets
         raw_input ? normalize_input(raw_input) : :abort
+      rescue Interrupt
+        :abort
       end
 
       def normalize_input(raw_input)

data/lib/console_kit/version.rb

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

data/lib/console_kit.rb

@@ -7,6 +7,8 @@ require 'active_support/core_ext/string/inflections'
 require_relative 'console_kit/version'
 require_relative 'console_kit/configuration'
 require_relative 'console_kit/setup'
+require_relative 'console_kit/console_helpers'
+require_relative 'console_kit/prompt'
 require_relative 'console_kit/railtie' if defined?(Rails::Railtie)
 
 # Main module for ConsoleKit
@@ -21,7 +23,7 @@ module ConsoleKit
     def reset_configuration!
       @configuration = nil
       Setup.current_tenant = nil
-      TenantConfigurator.configuration_success = false
+      TenantConfigurator.configuration_success = false if defined?(TenantConfigurator)
     end
 
     def pretty_output = configuration.pretty_output
@@ -42,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

@@ -11,14 +11,20 @@ Rails.application.config.after_initialize do
     #     constants: {
     #       shard: :shard_1,
     #       mongo_db: 'mongo_db_1',
-    #       partner_code: 'partner_a'
+    #       partner_code: 'partner_a',
+    #       redis_db: 1,
+    #       elasticsearch_prefix: 'tenant_a',
+    #       environment: 'production'
     #     }
     #   },
     #   tenant_b: {
     #     constants: {
     #       shard: :shard_2,
     #       mongo_db: 'mongo_db_2',
-    #       partner_code: 'partner_b'
+    #       partner_code: 'partner_b',
+    #       redis_db: 2,
+    #       elasticsearch_prefix: 'tenant_b',
+    #       environment: 'staging'
     #     }
     #   }
     # }
@@ -31,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.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Soumyadeep Pal
@@ -10,33 +10,47 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   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: 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
@@ -44,26 +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,92 +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.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.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