console_kit 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c68e98f9ea76d56039a31aee01f4642c23bc89e9b41868f988efff84f891647
-  data.tar.gz: 87be1db75fcb8d80851409a1903fe136d09e6275e5db9797b74f18df28603c63
+  metadata.gz: 2171674e2c587a2bb53387614758fefb8c6542f7ddb88c1b9dc55f85bf5a481a
+  data.tar.gz: 0fe05d8f5e3ee8d8814bba1b1eef1c3233b5c1996d805a4e2b06615326771480
 SHA512:
-  metadata.gz: f339cda7362c7a913918b992395ebd84ab4db2601a8c4d778302ae2579a1adfffab19d8eb63ca669b1d669ed9c58b589bfbe18c0d4ce758b83667b5935ebf304
-  data.tar.gz: c171cf918f2ea0ebe30c292f7b09847f3974c2fc39c55e21e36845c0399e04d7bc1b6558a8022bf860a57ae25403148ce62ef58748a7aad527ef55a870e6c5dd
+  metadata.gz: 763f319a96484ab677cad3eab21cc929e2775a98cf3d085db4fd317db8523f8220a3bcd808cedb3df857d193d1da9544de47a1263a8192a50888352e2fe1a575
+  data.tar.gz: 7acf3b5134fd7155ca4ceaadd44d07e93bf2f48fe322d4133055e11a8436157dcdf7b3ed7b303c76149674beccbd26780d5883590659aa040a8f55f8a7792cf0

data/CHANGELOG.md

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

@@ -1,5 +1,11 @@
 # 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 and context configuration via an easy CLI interface and Rails integration.
@@ -52,9 +58,39 @@ ConsoleKit.configure do |config|
   }
 
   config.context_class = CurrentContext
+
+  # Optional: Toggle pretty CLI output
+  config.pretty_output = true
 end
 ```
 
+## Console Usage
+
+When launching the Rails console, ConsoleKit will prompt you to select a tenant (if tenants are configured).
+You can also manually interact with it:
+
+### Get Current Tenant
+```ruby
+ConsoleKit.current_tenant
+# => :tenant_one
+```
+
+### Reset Current Tenant
+```ruby
+ConsoleKit.reset_current_tenant
+# => nil
+```
+
+### Manually Disable Pretty Output
+```ruby
+ConsoleKit.enable_pretty_output
+```
+
+### Manually Disable Pretty Output
+```ruby
+ConsoleKit.disable_pretty_output
+```
+
 ## 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.
@@ -63,7 +99,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at 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).
+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
 

data/lib/console_kit/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ConsoleKit
+  # Stores configurations
+  class Configuration
+    attr_accessor :pretty_output, :tenants, :context_class
+
+    def initialize(pretty_output: true, tenants: nil, context_class: nil)
+      @pretty_output = pretty_output
+      @tenants = tenants
+      @context_class = context_class
+    end
+  end
+end

data/lib/console_kit/output.rb

@@ -3,40 +3,47 @@
 module ConsoleKit
   # Handles Console outputs
   module Output
-    class << self
-      def print_error(text)
-        print_message("[✗] #{text}", '1;31') # Red
-      end
+    PREFIX = '[ConsoleKit]'
+    TYPES = {
+      error: { symbol: '[✗]', color: '1;31' },
+      success: { symbol: '[✓]', color: '1;32' },
+      warning: { symbol: '[!]', color: '1;33' },
+      prompt: { symbol: nil,   color: '1;36' },
+      header: { symbol: nil,   color: '1;34' },
+      trace: { symbol: nil, color: '0;90' },
+      info: { symbol: nil, color: nil }
+    }.freeze
 
-      def print_success(text)
-        print_message("[✓] #{text}", '1;32') # Green
+    class << self
+      TYPES.each_key do |type|
+        define_method("print_#{type}") do |text|
+          formatted = (type == :header ? "\n=== #{text} ===" : text)
+          print_with(type, formatted)
+        end
       end
 
       def print_backtrace(exception)
-        exception.backtrace.each { |line| print_message("    #{line}", '0;90') } # Dim gray
-      end
-
-      def print_header(text)
-        print_message("\n=== #{text} ===", '1;34') # Bold Blue
+        exception&.backtrace&.each { |line| print_with(:trace, "    #{line}") }
       end
 
-      def print_info(text)
-        print_message(text)
-      end
+      private
 
-      def print_prompt(text)
-        print_message(text, '1;36') # Cyan
+      def print_with(type, text, timestamp: false)
+        meta = TYPES[type]
+        message = build_message(text, meta[:symbol], timestamp)
+        output(message, meta[:color])
       end
 
-      def print_warning(text)
-        print_message("[!] #{text}", '1;33') # Yellow
+      def build_message(text, symbol, timestamp)
+        time = timestamp ? "[#{Time.current.strftime('%Y-%m-%d %H:%M:%S')}] " : ''
+        sym = symbol ? "#{symbol} " : ''
+        "#{PREFIX} #{time}#{sym}#{text}"
       end
 
-      private
+      def output(message, color)
+        return puts message unless ConsoleKit.configuration.pretty_output && color
 
-      def print_message(text, color = nil)
-        msg = "[ConsoleKit] #{text}"
-        puts color ? "\e[#{color}m#{msg}\e[0m" : msg
+        puts "\e[#{color}m#{message}\e[0m"
       end
     end
   end

data/lib/console_kit/railtie.rb

@@ -3,8 +3,6 @@
 module ConsoleKit
   # Railtie
   class Railtie < Rails::Railtie
-    console do
-      ConsoleKit.setup
-    end
+    console { ConsoleKit::Setup.setup }
   end
 end

data/lib/console_kit/setup.rb

@@ -6,46 +6,72 @@ require_relative 'output'
 
 # Core Logic for initial Setup
 module ConsoleKit
-  class << self
-    attr_accessor :tenants, :context_class
+  # Does the initial setup
+  module Setup
+    class << self
+      attr_reader :current_tenant
 
-    def setup
-      return Output.print_error('No tenants configured.') if tenants.nil? || tenants.empty?
+      def setup
+        return Output.print_error('No tenants configured.') if no_tenants?
 
-      tenant_key = resolve_tenant_key
-      return Output.print_error('No tenant selected. Loading without tenant configuration.') unless tenant_key
+        key = select_tenant_key
+        return Output.print_error('No tenant selected. Loading without tenant configuration.') unless key
 
-      initialize_tenant(tenant_key)
-    rescue StandardError => e
-      handle_setup_error(e)
-    end
+        configure(key)
+      rescue StandardError => e
+        handle_error(e)
+      end
 
-    def configure
-      yield self
-    end
+      def tenant_setup_successful? = !@current_tenant.to_s.empty?
 
-    private
+      def reset_current_tenant
+        return warn_no_tenants unless tenants?
 
-    def resolve_tenant_key
-      single_tenant? || non_interactive? ? tenants.keys.first : TenantSelector.select(tenants, tenants.keys)
-    end
+        warn_reset if @current_tenant
+        TenantConfigurator.clear(ConsoleKit.configuration.context_class) if @current_tenant
 
-    def single_tenant?
-      tenants.size == 1
-    end
+        @current_tenant = nil
+        setup
+        tenant_setup_successful?
+      end
 
-    def non_interactive?
-      !$stdin.tty?
-    end
+      private
 
-    def initialize_tenant(tenant_key)
-      TenantConfigurator.configure_tenant(tenant_key, tenants, context_class)
-      Output.print_success("Tenant initialized: #{tenant_key}")
-    end
+      def configure(key)
+        return unless TenantConfigurator.configure_tenant(key, tenants, context_class)
+
+        @current_tenant = key
+        Output.print_success("Tenant initialized: #{key}")
+      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
+        return tenants.keys.first if auto_select?
+
+        TenantSelector.select(tenants, tenants.keys)
+      end
+
+      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 handle_setup_error(error)
-      Output.print_error("Error setting up tenant: #{error.message}")
-      Output.print_backtrace(error)
+      def handle_error(error)
+        Output.print_error("Error setting up tenant: #{error.message}")
+        Output.print_backtrace(error)
+      end
     end
   end
 end

data/lib/console_kit/tenant_configurator.rb

@@ -7,31 +7,66 @@ module ConsoleKit
   module TenantConfigurator
     class << self
       def configure_tenant(key, tenants, context_class)
-        config = tenants[key]
-        return Output.print_error("No configuration found for tenant: #{key}") unless config
+        constants = tenants[key]&.[](:constants)
+        return missing_config_error(key) unless constants
 
-        constants = config[:constants]
+        validate_constants!(constants)
         apply_context(context_class, constants)
-        setup_database_connections(context_class)
+        setup_connections(context_class)
 
         Output.print_success("Tenant set to: #{key}")
+        true
       rescue StandardError => e
-        Output.print_error("Failed to configure tenant '#{key}': #{e.message}")
-        Output.print_backtrace(e)
+        handle_error(e, key)
+        false
+      end
+
+      def clear(context_class)
+        %i[tenant_shard tenant_mongo_db partner_identifier].each do |attr|
+          context_class.public_send("#{attr}=", nil)
+        end
+        Output.print_info('Tenant context has been cleared.')
       end
 
       private
 
-      def apply_context(context_class, constants)
-        context_class.tenant_shard = constants[:shard]
-        context_class.tenant_mongo_db = constants[:mongo_db]
-        context_class.partner_identifier = constants[:partner_code]
+      def validate_constants!(constants)
+        missing = %i[shard partner_code] - constants.keys
+        raise "Tenant constants missing keys: #{missing.join(', ')}" unless missing.empty?
+      end
+
+      def missing_config_error(key)
+        Output.print_error("No configuration found for tenant: #{key}")
+        false
+      end
+
+      def apply_context(ctx, constant)
+        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)
       end
 
       def setup_database_connections(context_class)
-        ApplicationRecord.establish_connection(context_class.tenant_shard.to_sym)
+        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?
+
         Mongoid.override_client(context_class.tenant_mongo_db.to_s)
       end
+
+      def handle_error(error, key)
+        Output.print_error("Failed to configure tenant '#{key}': #{error.message}")
+        Output.print_backtrace(error)
+      end
     end
   end
 end

data/lib/console_kit/tenant_selector.rb

@@ -9,11 +9,12 @@ module ConsoleKit
       def select(tenants, keys)
         print_tenant_selection_menu(tenants, keys)
 
-        max_attempts = 3
-        max_attempts.times do
+        3.times do |attempt|
           index = prompt_user_for_selection(keys.size)
           return nil if index.zero?
           return keys[index - 1] if index.positive?
+
+          print_tenant_selection_menu(tenants, keys) if attempt < 2
         end
 
         nil
@@ -35,7 +36,6 @@ module ConsoleKit
         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)
 
         parsed_index = input.to_i
@@ -44,14 +44,8 @@ module ConsoleKit
         parsed_index
       end
 
-      def valid_integer?(input)
-        input.match?(/\A\d+\z/)
-      end
-
-      def invalid_input_response
-        Output.print_warning('Invalid input. Please enter a number.')
-        -1
-      end
+      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 invalid_range_response(max_index)
         Output.print_warning("Selection must be between 0 and #{max_index}.")

data/lib/console_kit/version.rb

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

data/lib/console_kit.rb

@@ -1,10 +1,29 @@
 # frozen_string_literal: true
 
 require_relative 'console_kit/version'
+require_relative 'console_kit/configuration'
 require_relative 'console_kit/setup'
 require_relative 'console_kit/railtie' if defined?(Rails::Railtie)
 
+# Main module for console kit
 module ConsoleKit
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    def configure = yield(configuration)
+
+    def configuration = Thread.current[:console_kit_configuration] ||= Configuration.new
+    def reset_configuration! = Thread.current[:console_kit_configuration] = nil
+
+    %i[pretty_output tenants context_class].each do |name|
+      define_method(name) { configuration.public_send(name) }
+      define_method("#{name}=") { |val| configuration.public_send("#{name}=", val) }
+    end
+
+    def current_tenant = Setup.current_tenant
+    def reset_current_tenant = Setup.reset_current_tenant
+
+    def enable_pretty_output = configuration.pretty_output = true
+    def disable_pretty_output = configuration.pretty_output = false
+  end
 end

data/lib/generators/console_kit/install_generator.rb

@@ -9,20 +9,25 @@ module ConsoleKit
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
 
+      class_option :force, type: :boolean, default: false, desc: 'Overwrite existing files'
+
       def copy_initializer
         initializer_path = Rails.root.join('config', 'initializers', 'console_kit.rb')
 
-        if File.exist?(initializer_path)
-          say_status('skipped', "Initializer already exists: #{initializer_path}", :yellow)
+        if File.exist?(initializer_path) && !options[:force]
+          say_status :skipped, "Initializer already exists: #{initializer_path}", :yellow
         else
-          template 'console_kit.rb', 'config/initializers/console_kit.rb'
-          say_status('created', "Initializer generated at #{initializer_path}", :green)
+          template 'console_kit.rb', 'config/initializers/console_kit.rb', force: options[:force]
+          say_status :created, "Initializer generated at #{initializer_path}", :green
         end
       end
 
       def remind_about_customization
         say "\n✅ Setup complete!", :green
-        say '👉 Please update `config/initializers/console_kit.rb` to set your `tenants` and `context_class`.', :green
+        say '📄 Modify `config/initializers/console_kit.rb`:', :green
+        %w[tenants context_class].each do |field|
+          say "  - Set `#{field}` (required)", :green
+        end
       end
     end
   end

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

@@ -5,15 +5,20 @@
 
 Rails.application.config.after_initialize do
   ConsoleKit.configure do |config|
-    # TODO: Set your tenants source in the following format
+    # TODO: Set your tenants source, example:
     # {
-    #   key:
-    #   {
-    #     constants:
-    #     {
-    #       shard: # Active Record Shard
-    #       mongo_db: # Mongo Shard (If Mongo Is being used)
-    #       partner_code: # If partners are needed
+    #   tenant_a: {
+    #     constants: {
+    #       shard: :shard_1,
+    #       mongo_db: 'mongo_db_1',
+    #       partner_code: 'partner_a'
+    #     }
+    #   },
+    #   tenant_b: {
+    #     constants: {
+    #       shard: :shard_2,
+    #       mongo_db: 'mongo_db_2',
+    #       partner_code: 'partner_b'
     #     }
     #   }
     # }
@@ -21,5 +26,18 @@ Rails.application.config.after_initialize do
 
     # TODO: Set your context class (e.g., CurrentContext)
     config.context_class = nil
+
+    # Toggle pretty output on/off (default: true)
+    config.pretty_output = true
+
+    if config.tenants.nil?
+      warn '[ConsoleKit] Warning: `tenants` is not configured. ' \
+           'Please set it in config/initializers/console_kit.rb'
+    end
+
+    if config.context_class.nil?
+      warn '[ConsoleKit] Warning: `context_class` is not configured. ' \
+           'Please set it in config/initializers/console_kit.rb'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Soumyadeep Pal
@@ -52,6 +52,7 @@ files:
 - README.md
 - Rakefile
 - lib/console_kit.rb
+- lib/console_kit/configuration.rb
 - lib/console_kit/output.rb
 - lib/console_kit/railtie.rb
 - lib/console_kit/setup.rb