console_kit 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2d0c26442743fd36188fcb719990675c771eb719974a847a90f404a7b3219d5
-  data.tar.gz: 1be941647df505e1972fbf80aaa2bb49c1e74b6f029938c19e0f28f02c390c4d
+  metadata.gz: 8c68e98f9ea76d56039a31aee01f4642c23bc89e9b41868f988efff84f891647
+  data.tar.gz: 87be1db75fcb8d80851409a1903fe136d09e6275e5db9797b74f18df28603c63
 SHA512:
-  metadata.gz: e691e2c0ea5658d03799fc037f9db6fddda50293224ccf5461295a81f7096bc44a2115ec9df3de697619b5532b3d92ddeec2c07204ac80c46c1a52cd35dd1ae2
-  data.tar.gz: b6bc30dc509a8ce4bb98b7adb903e7b6dffbf96973d3afc11b8d4777feb73b69d96f3ceb5ef43205bac175247383ebc3b02d08c3ecaf87df96d3136d18161ef1
+  metadata.gz: f339cda7362c7a913918b992395ebd84ab4db2601a8c4d778302ae2579a1adfffab19d8eb63ca669b1d669ed9c58b589bfbe18c0d4ce758b83667b5935ebf304
+  data.tar.gz: c171cf918f2ea0ebe30c292f7b09847f3974c2fc39c55e21e36845c0399e04d7bc1b6558a8022bf860a57ae25403148ce62ef58748a7aad527ef55a870e6c5dd

data/.rubocop.yml

@@ -1,8 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.1
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/CHANGELOG.md

@@ -1,5 +1,43 @@
-## [Unreleased]
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/).
+
+---
+
+## [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.
+
+---
+
+## [Unreleased]
+
+[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

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+[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

data/README.md

@@ -1,28 +1,59 @@
 # ConsoleKit
 
-TODO: Delete this and the text below, and describe your gem
+A simple and flexible multi-tenant console setup toolkit for Rails applications.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/console_kit`. To experiment with that code, run `bin/console` for an interactive prompt.
+ConsoleKit helps you manage tenant-specific database connections and context configuration via an easy CLI interface and Rails integration.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```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:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem install console_kit
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+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' }
+    },
+    tenant_two: {
+      constants: { shard: :tenant_two_db, mongo_db: :tenant_two_mongo, partner_code: 'partnerB' }
+    }
+  }
+
+  config.context_class = CurrentContext
+end
+```
 
 ## Development
 
@@ -32,7 +63,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/[USERNAME]/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/[USERNAME]/console_kit/blob/master/CODE_OF_CONDUCT.md).
+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).
 
 ## License
 
@@ -40,4 +71,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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/[USERNAME]/console_kit/blob/master/CODE_OF_CONDUCT.md).
+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/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/console_kit/output.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ConsoleKit
+  # Handles Console outputs
+  module Output
+    class << self
+      def print_error(text)
+        print_message("[✗] #{text}", '1;31') # Red
+      end
+
+      def print_success(text)
+        print_message("[✓] #{text}", '1;32') # Green
+      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
+      end
+
+      def print_info(text)
+        print_message(text)
+      end
+
+      def print_prompt(text)
+        print_message(text, '1;36') # Cyan
+      end
+
+      def print_warning(text)
+        print_message("[!] #{text}", '1;33') # Yellow
+      end
+
+      private
+
+      def print_message(text, color = nil)
+        msg = "[ConsoleKit] #{text}"
+        puts color ? "\e[#{color}m#{msg}\e[0m" : msg
+      end
+    end
+  end
+end

data/lib/console_kit/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ConsoleKit
+  # Railtie
   class Railtie < Rails::Railtie
     console do
       ConsoleKit.setup

data/lib/console_kit/setup.rb

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
 
+require_relative 'tenant_selector'
+require_relative 'tenant_configurator'
+require_relative 'output'
+
+# Core Logic for initial Setup
 module ConsoleKit
   class << self
     attr_accessor :tenants, :context_class
 
     def setup
-      return print_error("No tenants configured.") if tenants.nil? || tenants.empty?
+      return Output.print_error('No tenants configured.') if tenants.nil? || tenants.empty?
 
-      tenant_key = tenants.size == 1 || !$stdin.tty? ? tenants.keys.first : select_tenant(tenants.keys)
-      return print_error("No tenant selected. Loading without tenant configuration.") unless tenant_key
+      tenant_key = resolve_tenant_key
+      return Output.print_error('No tenant selected. Loading without tenant configuration.') unless tenant_key
 
-      configure_tenant(tenant_key)
-      print_success("Tenant initialized: #{tenant_key}")
+      initialize_tenant(tenant_key)
     rescue StandardError => e
-      print_error("Error setting up tenant: #{e.message}")
-      print_backtrace(e)
+      handle_setup_error(e)
     end
 
     def configure
@@ -23,88 +26,26 @@ module ConsoleKit
 
     private
 
-    def select_tenant(keys)
-      print_header("Multiple tenants detected. Please choose one:")
-      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'
-        print_info("  #{index + 1}. #{key} (partner: #{partner})")
-      end
-
-      max_attempts = 3
-      selected_key = nil
-
-      max_attempts.times do
-        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?
-
-        unless (index = input.to_i) && index.between?(0, keys.size)
-          print_warning("Invalid selection. Please try again.")
-          next
-        end
-
-        return nil if index.zero?
-
-        selected_key = keys[index - 1]
-        break
-      end
-
-      selected_key
-    end
-
-    def configure_tenant(key)
-      config = tenants[key]
-      constants = config[:constants]
-
-      tenant_shard = constants[:shard]
-      tenant_mongo_db = constants[:mongo_db]
-
-      context_class.tenant_shard = tenant_shard
-      context_class.tenant_mongo_db = tenant_mongo_db
-      context_class.partner_identifier = constants[:partner_code]
-
-      ApplicationRecord.establish_connection(tenant_shard.to_sym)
-      Mongoid.override_client(tenant_mongo_db.to_s)
-
-      print_success("Tenant set to: #{key}")
-    rescue StandardError => e
-      print_error("Failed to configure tenant '#{key}': #{e.message}")
-      print_backtrace(e)
-    end
-
-    def print_error(text)
-      print_message("[✗] #{text}", '1;31') # Red
-    end
-
-    def print_success(text)
-      print_message("[✓] #{text}", '1;32') # Green
-    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
+    def resolve_tenant_key
+      single_tenant? || non_interactive? ? tenants.keys.first : TenantSelector.select(tenants, tenants.keys)
     end
 
-    def print_info(text)
-      print_message(text)
+    def single_tenant?
+      tenants.size == 1
     end
 
-    def print_prompt(text)
-      print_message(text, '1;36') # Cyan
+    def non_interactive?
+      !$stdin.tty?
     end
 
-    def print_warning(text)
-      print_message("[!] #{text}", '1;33') # Yellow
+    def initialize_tenant(tenant_key)
+      TenantConfigurator.configure_tenant(tenant_key, tenants, context_class)
+      Output.print_success("Tenant initialized: #{tenant_key}")
     end
 
-    def print_message(text, color = nil)
-      msg = "[ConsoleKit] #{text}"
-      puts color ? "\e[#{color}m#{msg}\e[0m" : msg
+    def handle_setup_error(error)
+      Output.print_error("Error setting up tenant: #{error.message}")
+      Output.print_backtrace(error)
     end
   end
 end

data/lib/console_kit/tenant_configurator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'output'
+
+module ConsoleKit
+  # For tenant configuration
+  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 = config[:constants]
+        apply_context(context_class, constants)
+        setup_database_connections(context_class)
+
+        Output.print_success("Tenant set to: #{key}")
+      rescue StandardError => e
+        Output.print_error("Failed to configure tenant '#{key}': #{e.message}")
+        Output.print_backtrace(e)
+      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]
+      end
+
+      def setup_database_connections(context_class)
+        ApplicationRecord.establish_connection(context_class.tenant_shard.to_sym)
+        Mongoid.override_client(context_class.tenant_mongo_db.to_s)
+      end
+    end
+  end
+end

data/lib/console_kit/tenant_selector.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'output'
+
+module ConsoleKit
+  # For tenant selection
+  module TenantSelector
+    class << self
+      def select(tenants, keys)
+        print_tenant_selection_menu(tenants, keys)
+
+        max_attempts = 3
+        max_attempts.times do
+          index = prompt_user_for_selection(keys.size)
+          return nil if index.zero?
+          return keys[index - 1] if index.positive?
+        end
+
+        nil
+      end
+
+      private
+
+      def print_tenant_selection_menu(tenants, keys)
+        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})")
+        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)
+
+        parsed_index = input.to_i
+        return invalid_range_response(max_index) unless parsed_index.between?(0, max_index)
+
+        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 invalid_range_response(max_index)
+        Output.print_warning("Selection must be between 0 and #{max_index}.")
+        -1
+      end
+    end
+  end
+end

data/lib/console_kit/version.rb

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

data/lib/console_kit.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "console_kit/version"
-require_relative "console_kit/setup"
-require_relative "console_kit/railtie" if defined?(Rails::Railtie)
+require_relative 'console_kit/version'
+require_relative 'console_kit/setup'
+require_relative 'console_kit/railtie' if defined?(Rails::Railtie)
 
 module ConsoleKit
   class Error < StandardError; end

data/lib/generators/console_kit/install_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/base'
+
+module ConsoleKit
+  module Generators
+    # Generates the required files
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      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)
+        else
+          template 'console_kit.rb', 'config/initializers/console_kit.rb'
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Auto-generated by ConsoleKit
+# 👉 Customize the following configuration to fit your application
+
+Rails.application.config.after_initialize do
+  ConsoleKit.configure do |config|
+    # TODO: Set your tenants source in the following format
+    # {
+    #   key:
+    #   {
+    #     constants:
+    #     {
+    #       shard: # Active Record Shard
+    #       mongo_db: # Mongo Shard (If Mongo Is being used)
+    #       partner_code: # If partners are needed
+    #     }
+    #   }
+    # }
+    config.tenants = nil
+
+    # TODO: Set your context class (e.g., CurrentContext)
+    config.context_class = nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Soumyadeep Pal
@@ -10,33 +10,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.2.1
 description: Adds tenant selection to Rails consoles
 email:
 - soumyadeeppal2001@gmail.com
@@ -52,9 +52,14 @@ files:
 - README.md
 - Rakefile
 - lib/console_kit.rb
+- lib/console_kit/output.rb
 - lib/console_kit/railtie.rb
 - lib/console_kit/setup.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: