console_kit 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2171674e2c587a2bb53387614758fefb8c6542f7ddb88c1b9dc55f85bf5a481a
-  data.tar.gz: 0fe05d8f5e3ee8d8814bba1b1eef1c3233b5c1996d805a4e2b06615326771480
+  metadata.gz: 634e983d59fba9a10d608945d11f0be809c4b3008612c804489a0ee18fd8bcf0
+  data.tar.gz: 646bf39efa3b81058524433d88852906313c20e0b584b1e205386bae45b8e638
 SHA512:
-  metadata.gz: 763f319a96484ab677cad3eab21cc929e2775a98cf3d085db4fd317db8523f8220a3bcd808cedb3df857d193d1da9544de47a1263a8192a50888352e2fe1a575
-  data.tar.gz: 7acf3b5134fd7155ca4ceaadd44d07e93bf2f48fe322d4133055e11a8436157dcdf7b3ed7b303c76149674beccbd26780d5883590659aa040a8f55f8a7792cf0
+  metadata.gz: 70f8f1282f3e6a63588187a86de442b663f17efd40773f7ad6c2916a21917549917d5fa9fba688774e18608f173e8126cee711cb468faf94efdda1ef7653151d
+  data.tar.gz: 436bfcb527f71341dd2f6fe1b865a884b4e4208a4dec75820e2bc46068de85db706f2e037e2b1aa94f07091600e204c35ef89cff612dd2bb103ae6d1baa414f7

data/.reek.yml

@@ -0,0 +1,4 @@
+detectors:
+  UncommunicativeVariableName:
+    exclude:
+      - e

data/.rubocop.yml

@@ -1,5 +1,10 @@
 AllCops:
   TargetRubyVersion: 3.1
+  NewCops: enable
+
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -6,6 +6,12 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ---
 
+## [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.
@@ -50,6 +56,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+[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

data/SECURITY.md

@@ -0,0 +1,28 @@
+# 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          |
+| ------- | ------------------ |
+| 0.1.4   | :white_check_mark: |
+| 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/lib/console_kit/configuration.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
 module ConsoleKit
-  # Stores configurations
+  # Stores ConsoleKit configurations such as tenant map and context behavior
   class Configuration
-    attr_accessor :pretty_output, :tenants, :context_class
+    attr_reader :pretty_output, :tenants, :context_class
 
-    def initialize(pretty_output: true, tenants: nil, context_class: nil)
-      @pretty_output = pretty_output
+    def initialize(tenants: nil, context_class: nil)
+      @pretty_output = true
       @tenants = tenants
       @context_class = context_class
     end
+
+    %i[pretty_output tenants context_class].each do |attr|
+      define_method("#{attr}=") { |value| instance_variable_set("@#{attr}", value) }
+    end
   end
 end

data/lib/console_kit/connections/base_connection_handler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ConsoleKit
+  module Connections
+    # Parent class for connection handlers
+    class BaseConnectionHandler
+      attr_reader :context
+
+      def initialize(context) = @context = context
+
+      def connect
+        raise NotImplementedError, "#{self.class} must implement #connect"
+      end
+
+      def available? = false
+    end
+  end
+end

data/lib/console_kit/connections/connection_manager.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'sql_connection_handler'
+require_relative 'mongo_connection_handler'
+
+module ConsoleKit
+  module Connections
+    # Manages available connection handlers
+    class ConnectionManager
+      class << self
+        def available_handlers(context)
+          handler_classes.filter_map do |klass|
+            handler = klass.new(context)
+            handler if handler.available?
+          end
+        end
+
+        private
+
+        def handler_classes = BaseConnectionHandler.descendants
+      end
+    end
+  end
+end

data/lib/console_kit/connections/mongo_connection_handler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'base_connection_handler'
+
+module ConsoleKit
+  module Connections
+    # Handles MongoDB connections
+    class MongoConnectionHandler < BaseConnectionHandler
+      extend Forwardable
+
+      def_delegator :@context, :tenant_mongo_db
+
+      def connect
+        return if tenant_mongo_db.blank?
+
+        Output.print_info("Switching to MongoDB client: #{tenant_mongo_db}")
+        Mongoid.override_client(tenant_mongo_db)
+      rescue NoMethodError
+        Output.print_warning('Mongoid.override_client is not defined.')
+      end
+
+      def available? = defined?(Mongoid)
+    end
+  end
+end

data/lib/console_kit/connections/sql_connection_handler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'base_connection_handler'
+
+module ConsoleKit
+  module Connections
+    # Handles SQL connections
+    class SqlConnectionHandler < BaseConnectionHandler
+      extend Forwardable
+
+      def_delegator :@context, :tenant_shard
+
+      def connect
+        return if tenant_shard.blank?
+
+        Output.print_info("Establishing SQL connection to shard: #{tenant_shard}")
+        ApplicationRecord.establish_connection(tenant_shard.to_sym)
+      end
+
+      def available? = defined?(ApplicationRecord)
+    end
+  end
+end

data/lib/console_kit/output.rb

@@ -16,30 +16,33 @@ module ConsoleKit
 
     class << self
       TYPES.each_key do |type|
-        define_method("print_#{type}") do |text|
+        define_method("print_#{type}") do |text, timestamp: false|
           formatted = (type == :header ? "\n=== #{text} ===" : text)
-          print_with(type, formatted)
+          print_with(type, formatted, timestamp)
         end
       end
 
+      # Backtrace prints always with timestamp, no param
       def print_backtrace(exception)
-        exception&.backtrace&.each { |line| print_with(:trace, "    #{line}") }
+        exception&.backtrace&.each { |line| print_with(:trace, "    #{line}", true) }
       end
 
       private
 
-      def print_with(type, text, timestamp: false)
-        meta = TYPES[type]
+      def print_with(type, text, timestamp)
+        meta = TYPES.fetch(type)
         message = build_message(text, meta[:symbol], timestamp)
         output(message, meta[:color])
       end
 
       def build_message(text, symbol, timestamp)
-        time = timestamp ? "[#{Time.current.strftime('%Y-%m-%d %H:%M:%S')}] " : ''
-        sym = symbol ? "#{symbol} " : ''
-        "#{PREFIX} #{time}#{sym}#{text}"
+        "#{PREFIX} #{timestamp_prefix(timestamp)}#{symbol_prefix(symbol)}#{text}"
       end
 
+      def prefix_for(value) = value ? yield(value) : ''
+      def timestamp_prefix(timestamp) = prefix_for(timestamp) { Time.current.strftime('[%Y-%m-%d %H:%M:%S] ') }
+      def symbol_prefix(symbol) = prefix_for(symbol) { |sym| "#{sym} " }
+
       def output(message, color)
         return puts message unless ConsoleKit.configuration.pretty_output && color
 

data/lib/console_kit/railtie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ConsoleKit
-  # Railtie
+  # Railtie for integrating ConsoleKit with Rails console.
   class Railtie < Rails::Railtie
     console { ConsoleKit::Setup.setup }
   end

data/lib/console_kit/setup.rb

@@ -11,34 +11,39 @@ module ConsoleKit
     class << self
       attr_reader :current_tenant
 
-      def setup
-        return Output.print_error('No tenants configured.') if no_tenants?
-
-        key = select_tenant_key
-        return Output.print_error('No tenant selected. Loading without tenant configuration.') unless key
-
-        configure(key)
-      rescue StandardError => e
-        handle_error(e)
-      end
-
+      def setup = run_setup
       def tenant_setup_successful? = !@current_tenant.to_s.empty?
 
       def reset_current_tenant
         return warn_no_tenants unless tenants?
 
         warn_reset if @current_tenant
-        TenantConfigurator.clear(ConsoleKit.configuration.context_class) if @current_tenant
+        TenantConfigurator.clear if @current_tenant
 
         @current_tenant = nil
         setup
-        tenant_setup_successful?
       end
 
       private
 
+      def run_setup
+        return Output.print_error('No tenants configured.') if no_tenants?
+
+        select_and_configure
+      rescue StandardError => e
+        handle_error(e)
+      end
+
+      def select_and_configure
+        key = select_tenant_key
+        return Output.print_error('No tenant selected. Loading without tenant configuration.') unless key
+
+        configure(key)
+      end
+
       def configure(key)
-        return unless TenantConfigurator.configure_tenant(key, tenants, context_class)
+        TenantConfigurator.configure_tenant(key)
+        return unless TenantConfigurator.configuration_success
 
         @current_tenant = key
         Output.print_success("Tenant initialized: #{key}")
@@ -48,25 +53,12 @@ module ConsoleKit
       def context_class = ConsoleKit.configuration.context_class
       def tenants? = tenants&.any?
       def no_tenants? = !tenants?
-
-      def select_tenant_key
-        return tenants.keys.first if auto_select?
-
-        TenantSelector.select(tenants, tenants.keys)
-      end
-
+      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 warn_no_tenants
-        Output.print_warning('Cannot reset tenant: No tenants configured.')
-        false
-      end
-
-      def warn_reset
-        Output.print_warning("Resetting tenant: #{@current_tenant}")
-      end
+      def warn_no_tenants = Output.print_warning('Cannot reset tenant: No tenants configured.')
+      def warn_reset = Output.print_warning("Resetting tenant: #{@current_tenant}")
 
       def handle_error(error)
         Output.print_error("Error setting up tenant: #{error.message}")

data/lib/console_kit/tenant_configurator.rb

@@ -1,29 +1,27 @@
 # frozen_string_literal: true
 
 require_relative 'output'
+require_relative 'connections/connection_manager'
 
 module ConsoleKit
   # For tenant configuration
   module TenantConfigurator
     class << self
-      def configure_tenant(key, tenants, context_class)
-        constants = tenants[key]&.[](:constants)
-        return missing_config_error(key) unless constants
+      attr_reader :configuration_success
 
-        validate_constants!(constants)
-        apply_context(context_class, constants)
-        setup_connections(context_class)
+      def configure_tenant(key)
+        constants = ConsoleKit.configuration.tenants[key]&.[](:constants)
+        return missing_config_error(key) unless constants
 
-        Output.print_success("Tenant set to: #{key}")
-        true
+        perform_configuration(key, constants)
       rescue StandardError => e
         handle_error(e, key)
-        false
       end
 
-      def clear(context_class)
+      def clear
+        @configuration_success = false
         %i[tenant_shard tenant_mongo_db partner_identifier].each do |attr|
-          context_class.public_send("#{attr}=", nil)
+          ConsoleKit.configuration.context_class.public_send("#{attr}=", nil)
         end
         Output.print_info('Tenant context has been cleared.')
       end
@@ -36,34 +34,36 @@ module ConsoleKit
       end
 
       def missing_config_error(key)
+        @configuration_success = false
         Output.print_error("No configuration found for tenant: #{key}")
-        false
       end
 
-      def apply_context(ctx, constant)
+      def perform_configuration(key, constants)
+        validate_constants!(constants)
+        apply_context(constants)
+        configure_success(key)
+      end
+
+      def apply_context(constant)
+        ctx = ConsoleKit.configuration.context_class
         ctx.tenant_shard = constant[:shard]
         ctx.tenant_mongo_db = constant[:mongo_db]
         ctx.partner_identifier = constant[:partner_code]
-      end
-
-      def setup_connections(ctx)
-        ApplicationRecord.establish_connection(ctx.tenant_shard.to_sym) if defined?(ApplicationRecord)
-        return unless defined?(Mongoid) && Mongoid.respond_to?(:override_client)
-        return if ctx.tenant_mongo_db.nil? || ctx.tenant_mongo_db.empty?
 
-        client = ctx.tenant_mongo_db.to_s
-        Mongoid.override_client(client)
+        setup_connections(ctx)
       end
 
-      def setup_database_connections(context_class)
-        ApplicationRecord.establish_connection(context_class.tenant_shard.to_sym) if defined?(ApplicationRecord)
-        return unless defined?(Mongoid) && Mongoid.respond_to?(:override_client)
-        return if context_class.tenant_mongo_db.nil? || context_class.tenant_mongo_db.empty?
+      def setup_connections(context)
+        ConsoleKit::Connections::ConnectionManager.available_handlers(context).each(&:connect)
+      end
 
-        Mongoid.override_client(context_class.tenant_mongo_db.to_s)
+      def configure_success(key)
+        Output.print_success("Tenant set to: #{key}")
+        @configuration_success = true
       end
 
       def handle_error(error, key)
+        @configuration_success = false
         Output.print_error("Failed to configure tenant '#{key}': #{error.message}")
         Output.print_backtrace(error)
       end

data/lib/console_kit/tenant_selector.rb

@@ -5,51 +5,64 @@ require_relative 'output'
 module ConsoleKit
   # For tenant selection
   module TenantSelector
+    RETRY_LIMIT = 3
+    DEFAULT_SELECTION = '1'
+
     class << self
-      def select(tenants, keys)
-        print_tenant_selection_menu(tenants, keys)
+      def select
+        attempt_selection(RETRY_LIMIT)
+      end
 
-        3.times do |attempt|
-          index = prompt_user_for_selection(keys.size)
-          return nil if index.zero?
-          return keys[index - 1] if index.positive?
+      private
 
-          print_tenant_selection_menu(tenants, keys) if attempt < 2
-        end
+      def attempt_selection(retries_left)
+        return nil if retries_left.zero?
 
-        nil
+        print_tenant_selection_menu
+        selection = parse_user_selection
+        selection ? resolve_selection(selection) : attempt_selection(retries_left - 1)
       end
 
-      private
-
-      def print_tenant_selection_menu(tenants, keys)
+      def print_tenant_selection_menu
         Output.print_header('Multiple tenants detected. Please choose one:')
         Output.print_info('  0. Load without tenant (no tenant configuration)')
 
-        keys.each_with_index do |key, index|
-          partner = tenants.dig(key, :constants, :partner_code) || 'N/A'
-          Output.print_info("  #{index + 1}. #{key} (partner: #{partner})")
+        ConsoleKit.tenants.keys.each_with_index do |key, index|
+          Output.print_info("  #{index + 1}. #{key} (partner: #{tenant_partner(key)})")
         end
       end
 
-      def prompt_user_for_selection(max_index)
-        Output.print_prompt("\nEnter the number of the tenant you want (or press Enter for default '1'): ")
-        input = $stdin.gets&.chomp&.strip
-        input = '1' if input.to_s.empty?
-        return invalid_input_response unless valid_integer?(input)
+      def tenant_partner(key) = ConsoleKit.tenants.dig(key, :constants, :partner_code) || 'N/A'
 
-        parsed_index = input.to_i
-        return invalid_range_response(max_index) unless parsed_index.between?(0, max_index)
+      def parse_user_selection
+        input = read_input_with_default
+        return handle_invalid_input('Invalid input. Please enter a number.') unless valid_integer?(input)
 
-        parsed_index
+        index = input.to_i
+        unless valid_selection_index?(index)
+          return handle_invalid_input("Selection must be between 0 and #{max_index}.")
+        end
+
+        index
+      end
+
+      def read_input_with_default
+        prompt_message = "\nEnter the number of the tenant you want " \
+                         "(or press Enter for default '#{DEFAULT_SELECTION}'): "
+        Output.print_prompt(prompt_message)
+        input = $stdin.gets&.chomp&.strip
+        input.to_s.empty? ? DEFAULT_SELECTION : input
       end
 
+      def handle_invalid_input(message) = Output.print_warning(message).then { nil }
       def valid_integer?(input) = input.match?(/\A\d+\z/)
-      def invalid_input_response = Output.print_warning('Invalid input. Please enter a number.').then { - 1 }
+      def max_index = ConsoleKit.tenants.size
+      def valid_selection_index?(index) = index.between?(0, max_index)
+
+      def resolve_selection(index)
+        return nil if index.zero?
 
-      def invalid_range_response(max_index)
-        Output.print_warning("Selection must be between 0 and #{max_index}.")
-        -1
+        ConsoleKit.tenants.keys[index - 1]
       end
     end
   end

data/lib/console_kit/version.rb

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

data/lib/console_kit.rb

@@ -7,6 +7,7 @@ require_relative 'console_kit/railtie' if defined?(Rails::Railtie)
 
 # Main module for console kit
 module ConsoleKit
+  # Base error class for ConsoleKit-related exceptions.
   class Error < StandardError; end
 
   class << self

data/lib/generators/console_kit/install_generator.rb

@@ -12,12 +12,13 @@ module ConsoleKit
       class_option :force, type: :boolean, default: false, desc: 'Overwrite existing files'
 
       def copy_initializer
+        force = options[:force]
         initializer_path = Rails.root.join('config', 'initializers', 'console_kit.rb')
 
-        if File.exist?(initializer_path) && !options[:force]
+        if File.exist?(initializer_path) && !force
           say_status :skipped, "Initializer already exists: #{initializer_path}", :yellow
         else
-          template 'console_kit.rb', 'config/initializers/console_kit.rb', force: options[:force]
+          template 'console_kit.rb', 'config/initializers/console_kit.rb', force: force
           say_status :created, "Initializer generated at #{initializer_path}", :green
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Soumyadeep Pal
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -51,8 +52,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- 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/mongo_connection_handler.rb
+- lib/console_kit/connections/sql_connection_handler.rb
 - lib/console_kit/output.rb
 - lib/console_kit/railtie.rb
 - lib/console_kit/setup.rb
@@ -70,6 +76,7 @@ metadata:
   homepage_uri: https://github.com/Soumyadeep-ai/console_kit
   source_code_uri: https://github.com/Soumyadeep-ai/console_kit
   changelog_uri: https://github.com/Soumyadeep-ai/console_kit/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib