chess_cli 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 152e4d5131574d9b9e1df36fec0fddea92612cf9150cf46174b3c21d510469bd
+  data.tar.gz: 0cbf073ea9137c3d0371b13441aa44058410c68ef4b5cfb8a323d723d600f420
+SHA512:
+  metadata.gz: c2ed66ac03afe8730cb46284020d7d0e80a27f17876d188acb90a653e4f419cde6c9de4cf66c28e28f9780ca6b9d40de24616f9b60284a280f6ca19944c0235b
+  data.tar.gz: 0a4b54e353cd8d7977daa9fd2517860062307c57e78a6049cf0c06073ebfb7f6d17aa8e1787949dd215f9971fab7b5e1b4968412b45711539ce5b433e91f8c4e

data/.config/locale/debug_en.yml

@@ -0,0 +1,4 @@
+debug_en:
+  test_msg: "Hello, you are using the debug_en.yml text file."
+  test_msg2: "This is %{adj}!"
+  test_array: [obj: "nested", 123, ".yml"]

data/.config/locale/en.yml

@@ -0,0 +1,424 @@
+# Textfile for Chess
+en:
+  cli:
+    ver: "|<<-───────────────|⟡ Ruby Arcade ⟡ v%{ver} by Ancient Nimbus|───────────────->>|"
+    guideline: |
+      ___________________ ⟡ Ruby Arcade ⟡ v0.0.0 by Ancient Nimbus ___________________
+      |<<-|For best experience, adjust the terminal to fit this in a single line |->>|
+    boot: |
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      * │                                     *                                      │ 
+      * │                                    ***                                     │
+      * │                                   *****                                    │
+      * │                                 *********                                  │
+      * │                               *************                                │
+      * │                             *****************                              │
+      * │                               *************                                │
+      * │                                 *********                                  │
+      * │                                   *****                                    │
+      * │                                    ***                                     │
+      * │                                     *                                      │
+      * │           ___       ___       ___       ___       ___       ___            │
+      * │          /\  \     /\  \     /\  \     /\  \     /\  \     /\  \           │
+      * │         /::\  \   /::\  \   /::\  \   /::\  \   /::\  \   /::\  \          │
+      * │        /::\:\__\ /::\:\__\ /:/\:\__\ /::\:\__\ /:/\:\__\ /::\:\__\         │
+      * │        \/\::/  / \;:::/  / \:\ \/__/ \/\::/  / \:\/:/  / \:\:\/  /         │
+      * │          /:/  /   |:\/__/   \:\__\     /:/  /   \::/  /   \:\/  /          │
+      * │          \/__/     \|__|     \/__/     \/__/     \/__/     \/__/           │
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      * 
+      * To leave the arcade, type '--exit'
+    menu: |
+      * Games available in this release:
+      * +───────────────+───────────────+────────────────────────────────────────────+
+      * │ GAME          │ LAUNCH CODE   │ INFO                                       │
+      * +───────────────+───────────────+────────────────────────────────────────────+
+      * │ Chess         │ chess         │ Strategy, Patience, Victory.               │
+      * +───────────────+───────────────+────────────────────────────────────────────+
+      * 
+      * Type '--help' will display a list of available commands.
+      * To run a game, type '--play <launch code>' to run a game. 
+      * E.g., '--play chess'
+    help: |
+      * Ruby Arcade | Help Menu
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      * │ * Available commands at this page:  |                                      │
+      * │ * Help - [--help]                   | * Display all available commands     │
+      * │ * Save - [--save]                   | * Save user profile to local disc    │
+      * │ * Load - [--load]                   | * Load user profile from local disc  │
+      * │ * Self - [--self]                   | * Retrieve player profile info       │
+      * │ * Play - [--play] [<app name>]      | * Run an app e.g., '--play chess'    │
+      * │ * Info - [--info]                   | * Display system info                │
+      * │ * Exit - [--exit | --ttfn]          | * Safely close the program           │
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+    std_msg_prefix: "* "
+    std_err: "Invalid input, please try again: "
+    std_blank: "Press enter to continue "
+    std_help: |
+      * Ruby Arcade Intro | Help Menu
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      * │ * Available commands at this page:  |                                      │
+      * │ * Help - [--help]                   | * Display all available commands     │
+      * │ * Info - [--info]                   | * Display system info                │
+      * │ * Exit - [--exit | --ttfn]          | * Safely close the program           │
+      * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+    prompt_prefix: ">>> "
+    query_prefix: "? "
+    cmd_err: "Invalid command! type --help to view all available commands."
+    lobby:
+      msg: "Get started by typing a command: "
+      exit: "👾 Thank you for visiting Ruby Arcade 👾"
+      arcade: "Exiting %{app}... beaming you back to Ruby Arcade lobby."
+    new:
+      msg: |
+        * Welcome to ⟡ Ruby Arcade ⟡ T.O.P. Edition
+        * 
+        * If this is your first visit to the Arcade, enter [1] to create a new profile.
+        * If you have already created a profile, enter [2] to load your profile.
+      msg2: "Please specify a profile loading mode: "
+      msg3: "Please provide a username (Default: Arcade Player): "
+      msg4: |
+        * 👋 Greetings %{name}!
+    load:
+      li_col1: "List of User Profiles"
+      li_col2: "Last saved date"
+      msg: "Fetching user profile..."
+      msg2: "Choose a profile by typing the corresponding number:"
+      msg3: "Profile loaded! Welcome back %{name}!"
+      input_err: "Invalid input, please try again! To load the first profile, type '1'"
+      bad_file_err: "The chosen user profile is corrupted and cannot be loaded, creating a new profile now..."
+      no_profile_err: "No profile found, creating a new profile now..."
+      no_profile_err2: "No user profile found, operation cancelled"
+      unknown_err: "Unknown error, creating a new profile now..."
+    save:
+      msg: "Your profile has been saved and can be found at the following directory: \n==> '%{dir}'"
+    self:
+      msg: |
+        * Your profile info:
+        * Player ID: %{uuid}
+        * Last profile saved date: %{date}
+        * Username: %{name}
+        * Ruby Arcade visit count: %{visit}
+    play:
+      run: "Launching %{app}..."
+      test: "Launching %{app}... %{msg}"
+      run_err: "Invalid launch code, please try again."
+      gm_err: "No game manager available"
+    lol:
+      title:
+        - "Wow! You've found the secret command!"
+        - "Wait, that worked??"
+        - "Entering the super special menu... Just kidding XD"
+      sub:
+        - "Loading... still loading..."
+        - "Almost ready..."
+      msgs:
+        - "You have found me."
+        - "Fact of the day: The first commit of this project was pushed on June 17, 2025."
+        - "Tip of the day: GitHub projects is a helpful tool to stay organised."
+        - "Shout out to The Odin Project for creating excellent open source learning material."
+        - "Quote of the day: Our greatest glory is not in never falling, but in rising every time we fall."
+        - "Quote of the day: It does not matter how slowly you go as long as you do not stop."
+        - "Tip of the day: The best error message is the one that never shows up."
+        - "Quote of the day: Programs must be written for people to read, and only incidentally for machines to execute."
+  app:
+    chess:
+      boot: |
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+        * │                                                                            │
+        * │     ▓▓░░▓▓░░▓▓░░▓▓░░   AN/""""'\TT dP                                      │
+        * │     ░░▓▓░░▓▓░░▓▓░░▓▓   N/ .cCc. \O 88                                      │
+        * │     ▓▓░░▓▓░░▓▓░░▓▓░░   C  hHHHh `P 88                                      │
+        * │     ░░▓▓░░▓▓░░▓▓░░▓▓   I  EEEEEeeO 88d888b. .d8888b. .d8888b. .d8888b.     │
+        * │     ▓▓░░▓▓░░▓▓░░▓▓░░   E  sSSSSSSD 88'  `88 88ooood8 Y8ooooo. Y8ooooo.     │
+        * │     ░░▓▓░░▓▓░░▓▓░░▓▓   N. `sSs' .I 88    88 88.  ...       88       88     │
+        * │     ▓▓░░▓▓░░▓▓░░▓▓░░   TT.     .sN dP    dP `88888P' `88888P' `88888P'     │
+        * │     ░░▓▓░░▓▓░░▓▓░░▓▓   NIMBUSCHESS                                         │
+        * │                                                                            │
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+        * │                                   Chess                                    │
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+        * │             A Command Line Game by Ancient Nimbus | ver: 0.0.0             │
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      intro: |
+        * **How to start**
+        * A series of prompts will help setup the game for you in no time. 
+        * See below for what to expect:
+        * 1. Start a new game or load game from profile
+        *    • [1] New Game
+        *    • [2] Load Game
+        *
+        * 2. Select a game mode: (When New Game is selected)
+        *    • [1] Player vs Player
+        *    • [2] Player vs Computer (Level: Easy)
+        *
+        * 2. Select a game session to resume: (When Load Game is selected)
+        *    • A list of session linked to you will be loaded 
+        *    • Please enter a number to indicate the session you wish to load
+        *
+        * 3. You can give Player a name, you can skip this by leaving the input empty.
+        *    • Please name Player 1 (Default: Player 1)
+        *    • Please name Player 2 (Default: Player 2) (Mode 1 only)
+        *
+        * 4. You can choose to play as White or Black, or let the game decide randomly.
+        *    • [1] Play as White
+        *    • [2] Play as Black
+        *    • [3] Choose for me
+        *
+        * 5. A game save will be created, and it is stored locally at the ./data folder.
+      how_to: |
+        * **How to play**
+        * 1. In chess, White makes the first move, follow by Black.
+        * 2. This game uses Algebraic notation standard to process movements.
+        * 3. To make a move, type your move in notation format. (More info below)
+        * 4. The game features autosave, your progress is saved at the end of each move.
+        *
+        * Type '--help' will display a list of available commands.
+        * 
+        * A quick input tutorial is available by typing the following command:
+        * Type '--help alg' will display Algebraic input examples
+        * Type '--help smith' will display Smith input examples
+        *
+        * To learn more about chess, see: ↴
+        *   https://www.instructables.com/Playing-Chess/
+        * To learn more about Algebraic notation, see: ↴
+        *   https://www.chessable.com/blog/chess-notation-for-beginners/
+        * To learn more about Smith notation, see: ↴
+        *   https://en.wikipedia.org/wiki/Chess_notation#Notation_systems
+      help: |
+        * ♞ Ruby Chess by Ancient Nimbus | Help Menu
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+        * │ * Available commands at this page:  |                                      │
+        * │ * Help - [--help]                   | * Display all available commands     │
+        * │ * Algebraic Helper - [--help alg]   | * Display Algebraic input examples   │
+        * │ * Smith Helper - [--help smith]     | * Display Smith input examples       │
+        * │ * Info - [--info]                   | * Display game info                  │
+        * │ * Exit - [--exit | --ttfn]          | * Safely exit the game.              │
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+        * │ * In-Game settings:                 │                                      │
+        * │ * Save - [--save]                   | * Save session to player profile     │
+        * │ * Load - [--load]                   | * Load another session from profile  │
+        * │ * Input Algebraic - [--alg]         | * Use Algebraic notation as input    │
+        * │ * Input Smith - [--smith]           | * Use Smith notation as input        │
+        * │ * Board size - [--board size]       | * Set the board size to 1x or 2x     │
+        * │ * Board flip - [--board flip]       | * Enable/Disable board flipping      │
+        * │ * Export game - [--export]          | * Export current game as PGN file    │
+        * +──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+──────+
+      alg_h: |
+        * **Algebraic notation: Input examples**
+        * Pieces Symbols:
+        * • ♚: K, ♛: Q, ♜: R, ♝: B, ♞: N, ♟: (P) No symbol
+        *
+        * Movements:
+        * • 'e4' => 'Pawn to e4'
+        * • 'Nh3' => 'Knight to h3'
+        * 
+        * Capturing:
+        * • 'exd5' => 'Pawn captures d5'
+        * • 'Qxh7' => 'Queen captures h7'
+        *
+        * When multiple pieces can move/capture the same location (Disambiguation):
+        * Use file to specify (a to h):
+        * • 'Nbd2' => 'b-Knight to d2'
+        * • 'Rbxd4' => 'b-Rook captures d4'
+        * 
+        * Castling:
+        * • 'O-O' => 'Castle Kingside'
+        * • 'O-O-O' => 'Castle Queenside'
+        * 
+        * Pawn Promotion:
+        * Pawn can be prompted to a queen (Q), rook (R), bishop (B) or a knight (N).
+        * • 'e8=Q' => 'Pawn promotes to queen'
+        * • 'e8=R' => 'Pawn promotes to rook'
+      sm_h: |
+        * **Smith notation: Input examples**
+        * Pieces Symbols:
+        * • ♚: k, ♛: q, ♜: r, ♝: b, ♞: n, ♟: (p) No symbol
+        *
+        * Single Prompt Movement/Capturing:
+        * • 'e2e4' => 'Move a piece from e2 to e4'
+        *
+        * Dual Prompt Movement/Capturing:
+        * • 'e2' => Enter 'Preview mode' (Note: Once selected, you must play this piece)
+        * • 'e4' => Piece at 'e2' will move to 'e4'
+        * 
+        * Castling:
+        * • 'e1g1' => 'Castle Kingside'
+        * • 'e1c1' => 'Castle Queenside'
+        * 
+        * Pawn Promotion:
+        * Pawn can be prompted to a queen (q), rook (r), bishop (b) or a knight (n).
+        * • 'e7e8q' => 'Pawn promotes to queen'
+        * • 'e7e8r' => 'Pawn promotes to rook'
+      blanks:
+        enter: "Press enter to continue "
+        wait: "Please wait... "
+      load:
+        f1: |
+          * Start a new game or load game from profile/FEN
+          *   • [1] New Game
+          *   • [2] Load Game
+          *   • [3] Import Game via FEN data
+        f1a: "Please select a load mode: "
+        f1a_err: "Invalid input, please choose between 1 to 3: "
+        f2a: "Please enter a number to indicate the session you wish to load:"
+        f2b: "Select a game session to resume:"
+        f2b_err: "Invalid input, please choose between 1 to %{max}"
+        err: "The session you wish to load appears to be corrupted, exiting load game menu."
+      new:
+        f1: |
+          * Select a game mode:
+          *   • [1] Player vs Player
+          *   • [2] Player vs Computer (Level: Easy)
+        f1a: "Please select a game mode: "
+        f1a_err: "Invalid input, please choose between 1 or 2"
+        f2: "Please name Player %{count} (Default: %{name}) "
+        f2a: "Name has been updated to '%{name}'."
+        f3: "Provide a valid FEN below, invalid FEN will cancel the operation and a new game will be setup instead."
+        err: "Sessions not found, entering new game creation mode..."
+      order:
+        f1: |
+          * You can choose to play as White or Black, or let the game decide randomly.
+          *   • [1] Play as White
+          *   • [2] Play as Black
+          *   • [3] Choose for me
+        f1a: "Please enter a number: "
+        f1a_err: "Invalid input, please choose between 1 to 3"
+        f2: "All set! %{p1} will play as %{c1}, %{p2} will play as %{c2}."
+      session:
+        new: "Starting session: %{event}"
+        load: "Session: %{event} restored successfully. Welcome back %{p1}!"
+        restart: "Would you like to play another round of chess? "
+      cmd:
+        save: "This game features autosave. Progress is saved automatically at the end of each turn."
+        load: "Opening the list of available sessions..."
+        info: |
+          * ♞ Ruby Chess by Ancient Nimbus ver: %{ver}
+        info2: |
+          * Last saved date: %{date}
+          * FEN: %{fen}
+          * Event: %{event}
+          * White: %{w_player}
+          * Black: %{b_player}
+          * ♞ Ruby Chess by Ancient Nimbus ver: %{ver}
+        export: |
+          %{sep}
+
+          * Your Chess session has been exported as: '%{filename}'
+          * It can be found at the following directory: 
+          * ==> '%{dir}'
+          * You can also select and copy the text below: ↴
+          * To import a game, visit chess site such as: https://lichess.org/paste
+
+          %{pgn_out}
+
+          %{sep}
+        input:
+          alg: "Press 'enter' to switch input detection to Algebraic notation"
+          smith: "Press 'enter' to switch input detection to Smith notation"
+          done: "Input scheme has been updated!"
+          err: "This is not a valid selection, please try again!"
+        board:
+          err: "'board' command is expecting an additional keyword, type --help to view all possible commands."
+          size1: "Board size is set to standard"
+          size2: "Board size is set to large"
+          flip_on: "Board flipping enabled"
+          flip_off: "Board flipping disabled"
+        exit: "♚ Thank you for playing Chess, see you soon ♚"
+        err: "Invalid command! Type --help to view all available commands."
+        disabled: "This command is disabled here! Type --help to view all available commands."
+        std_err: "Invalid input, please try again: "
+        soon: "This feature will be made available soon."
+      level:
+        white: "White"
+        Black: "Black"
+        turn: "It is %{player}'s turn"
+        action1: "Pick a piece to move: "
+        action2: "Make a move: "
+        preview: "Previewing %{name}'s move at %{info}"
+        move: "%{player} has moved %{name} to %{info}"
+        capture: "%{player} has captured a %{side} %{def} at %{info}"
+        promo: "Promoting to %{new_name} at %{info}"
+        promo_alert: "Your Pawn is ready for a promotion! "
+        promo_opt: "Stunning your Pawn has reached the other side!"
+        castle: "King is castling to %{info}"
+        en_passant: "%{name} is performing en passant maneuver at %{info}"
+        check:
+          "A check from the %{type}! %{king_side} king is under attack!"
+          # - "%{king_side} king is in check, he'll have to respond!"
+          # - "A check from the %{type}! %{king_side} king is under attack!"
+          # - "It appears the %{king_side} king is in deep water!"
+          # More checkmate related strings
+          # - "A beautiful checkmate to end the game, congratulation %{win_player}!"
+          # - "%{win_side} delivered mate, the %{lose_side} crown has fallen!"
+        endgame:
+          checkmate: "That's checkmate! %{win_player} is victorious!"
+          stalemate: "It's a stalemate, the game is a draw!"
+          insufficient: "The game is a draw by insufficient material!"
+          fifty_move: "Fifty moves without a capture or pawn move, the game is a draw!"
+          threefold: "Round and around, the game is a draw by Threefold repetition!"
+        err:
+          select: "%{input} is not a valid selection, please try again."
+          move: "%{input} is not a valid move, please try again."
+          notation: "This is not a valid move, please try again."
+          promo: "Invalid option for promotion!"
+          promo2: "Valid option: ♛: q, ♜: r, ♝: b, ♞: n"
+      end:
+        home: "Welcome back to the lobby! Hope you have fun playing chess."
+      fen:
+        err: "FEN error, '%{fen_str}' is not a valid sequence. Starting a new game..."
+      misc:
+        site: "Ruby Arcade Terminal Chess by Ancient Nimbus"
+      status:
+        ongoing: "In Progress"
+        stalemate: "Draw"
+        insufficient: "Draw"
+        fifty_move: "Draw"
+        threefold: "Draw"
+        checkmate: "Checkmate"
+      pieces:
+        k:
+          name: "King"
+          notation: "K"
+          style1: "♚"
+          style2: "♔"
+        q:
+          name: "Queen"
+          notation: "Q"
+          style1: "♛"
+          style2: "♕"
+        r:
+          name: "Rook"
+          notation: "R"
+          style1: "♜"
+          style2: "♖"
+        b:
+          name: "Bishop"
+          notation: "B"
+          style1: "♝"
+          style2: "♗"
+        n:
+          name: "Knight"
+          notation: "N"
+          style1: "♞"
+          style2: "♘"
+        p:
+          name: "Pawn"
+          notation: "P"
+          style1: "♟"
+          style2: "♙"
+      board:
+        frame:
+          h: "═"
+          v: "║"
+          vh: "╬"
+          ulc: "╔"
+          urc: "╗"
+          ut: "╦"
+          llc: "╚"
+          lrc: "╝"
+          lt: "╩"
+        decor:
+          d1: "◆"
+          d2: "◇"
+          d3: "⋄"

data/bin/chess_cli

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "chess_cli"
+
+ChessCLI.run(lang: "en")

data/lib/chess_cli.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "console_game/game_manager"
+
+# Chess CLI Wrapper
+class ChessCLI
+  # Run Chess CLI
+  def self.run(lang: "en")
+    ConsoleGame::GameManager.new(lang:).run
+  end
+end

data/lib/console/console.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require "readline"
+
+# Game display & input capturing for console game
+# @author Ancient Nimbus
+# @version v2.1.0
+module Console
+  # Default message strings
+  D_MSG = { msg: "Using message printer", err_msg: "Invalid input, please try again: ",
+            prompt_prefix: ">>> ", query_prefix: "? ", warn_prefix: "! ", gear_icon: "⛭ ",
+            cmd_err: "Invalid command, type --help to view all available commands.",
+            cmd_pattern: "--(exit).*?", v_sep: "| " }.freeze
+
+  # prompt message helper
+  # @param msgs [Array<String>] message to print
+  # @param pre [String] message prefix
+  # @param suf [String] message suffix
+  # @param mode [Symbol] expecting the following symbols: `puts`, `print`, `p`
+  # @param delay [Integer] add delay between message print
+  # @param clear [Boolean] clear screen before print?
+  # @return [nil]
+  def print_msg(*msgs, pre: "", suf: "", mode: :puts, delay: 0, clear: false)
+    return ArgumentError("Invalid mode used for this method") unless %i[puts print p].include?(mode)
+
+    system("clear") if clear
+    msgs.each do |msg|
+      formatted_msg = "#{pre}#{msg}#{suf}"
+      method(mode).call(formatted_msg)
+      sleep(delay) if delay.positive?
+    end
+    nil
+  end
+
+  # process user input
+  # @param msg [String] first print
+  # @param cmds [Hash] expects a list of commands hash
+  # @param err_msg [String] second print
+  # @param reg [Regexp, String] pattern to match
+  # @param empty [Boolean] allow empty input value, default to false
+  # @return [String]
+  def ask(msg = "", cmds: { "exit" => method(:exit) }, err_msg: D_MSG[:err_msg], reg: /.*/, empty: false)
+    input = prompt_user(msg, err_msg: err_msg, reg: reg, empty: empty)
+    return input if input.empty?
+
+    input_arr = input.split(" ")
+    input_is_cmd, is_valid, cmd = command?(input_arr[0], cmds)
+
+    return input unless input_is_cmd
+
+    handle_command(cmd, input_arr[1..], cmds, is_valid)
+    ask(msg, cmds:, err_msg:, reg:, empty:)
+  end
+
+  # Build table
+  # @param data [Hash<String>] data
+  # @param head [String] the title of the table
+  # @return [Array<String>]
+  def build_table(data: {}, head: "Console Table")
+    data_values = data.values.map(&:values)
+    return "Non-string elements found, ops cancelled." unless data_values.all? { |_, v| v.is_a?(String) }
+
+    prefix_size, max_length = table_formatter(data_values)
+    build_header(data, head, prefix_size, max_length) + build_rows(data_values, max_length - prefix_size)
+  end
+
+  # Helper method to create regexp pattern
+  # @param cmd_pattern [String] command patterns
+  # @param reg [String] pattern to match
+  # @param pre [String] pattern prefix
+  # @param suf [String] pattern suffix
+  # @param flag [String, Regexp] regexp flag
+  # @return [Regexp]
+  def regexp_formatter(cmd_pattern = D_MSG[:cmd_pattern], reg = "reg", pre: '\A', suf: '\z', flag: "")
+    Regexp.new("#{pre}(#{reg}|#{cmd_pattern})#{suf}", flag)
+  end
+
+  # Shorthand method: handle range selections prompt, current number limit is up to 99.
+  # @param cmd_pattern [String] command patterns
+  # @param min [String, Integer] min range
+  # @param max [String, Integer] max range (inclusive)
+  # @param flag [String, Regexp] regexp flag
+  # @return [Regexp]
+  def regexp_range(cmd_pattern = D_MSG[:cmd_pattern], min: 1, max: 3, flag: "")
+    block = "[#{min}-#{max}]"
+    block = "[#{min}-9][0-#{max % 10}]?" if max.is_a?(Integer) && (max >= 10)
+
+    regexp_formatter(cmd_pattern, block, flag: flag)
+  end
+
+  # Helper method to build regexp capturing group
+  # @param reg [Array] elements
+  # @param pre [String] pattern prefix
+  # @param suf [String] pattern suffix
+  # @return [String]
+  def regexp_capturing_gp(reg = %w[reg abc], pre: "", suf: "") = "#{pre}(#{reg.join('|')})#{suf}"
+
+  private
+
+  # prompt user to collect input
+  # @param msg [String] first print
+  # @param err_msg [String] second print
+  # @param reg [Regexp] pattern to match
+  # @param empty [Boolean] allow empty input value, default to false
+  # @return [String] user input
+  def prompt_user(msg = "", err_msg: D_MSG[:err_msg], reg: /.*/, empty: false)
+    input = ""
+    query_symbol = Paint[D_MSG[:query_prefix], :green]
+    loop do
+      prompt_msg = "#{query_symbol}#{msg}#{D_MSG[:prompt_prefix]}"
+      input = Readline.readline(prompt_msg, true)
+      break if met_requirement?(input, reg, empty)
+
+      query_symbol = Paint[D_MSG[:warn_prefix], :red]
+      msg = err_msg
+    end
+    input.rstrip
+  end
+
+  # Handle prompt exit condition in a more precises manner
+  # @param input [String] user input to verify
+  # @param reg [Regexp] pattern to match
+  # @param empty [Boolean] allow empty input value, default to false
+  # @return [Boolean] true when requirement is met
+  def met_requirement?(input, reg, empty) = input.match?(reg) || (input.empty? if empty)
+
+  # returns true if user input matches available commands
+  # @param input [String] user input
+  # @param commands [Array<String>] command string keys
+  # @param flags [Array<String>] command pattern prefixes
+  # @return [Boolean, Array<Boolean, String>] whether it is a command or not
+  def command?(input, commands = %w[exit debug], flags: %w[--])
+    clean_input = nil
+    flags.each do |flag|
+      clean_input = input.delete_prefix(flag) if input[0...flag.size] == flag
+      break unless clean_input.nil?
+    end
+    return false if clean_input.nil?
+
+    [true, commands.include?(clean_input), clean_input]
+  end
+
+  # Handle command
+  # @param cmd [String]
+  # @param opt_arg [String]
+  # @param cmds [Array]
+  # @param is_valid [Boolean]
+  # @param cmd_err [String] custom error message
+  def handle_command(cmd, opt_arg, cmds, is_valid, cmd_err: D_MSG[:cmd_err])
+    return print_msg(cmd_err, pre: Paint[D_MSG[:warn_prefix], :red]) unless is_valid
+
+    begin
+      cmds.fetch(cmd).call(opt_arg)
+    rescue TypeError
+      cmd == "exit" ? cmds.fetch(cmd).call : raise(TypeError, "#{cmd} is missing optional argument: #{opt_arg}")
+    end
+  end
+
+  # == Build table helper ==
+
+  # Helper: Table formatter
+  # @param data_arr [Array<String>]
+  # @return [Array]
+  def table_formatter(data_arr)
+    row_counts = data_arr.size
+    prefix_size = ol_prefix(row_counts).size
+    max_length = 80
+    [prefix_size, max_length]
+  end
+
+  # Helper: Build Header row
+  # @return [Array<String>]
+  def build_header(data, head, prefix_size, row_length)
+    tb_col_heads = data.values[0].keys.map { |title| title.to_s.capitalize }
+    col_heads = tb_col_heads.join(D_MSG[:v_sep].rjust(row_length - prefix_size * 3))
+    separator = horizontal_line(row_length)
+    [head, separator, col_heads, separator]
+  end
+
+  # Helper: Build table row
+  # @param data_arr [Array<String>]
+  # @param tb_rows [Array<String>]
+  # @return [Array<String>]
+  def build_rows(data_arr, row_length, tb_rows = [])
+    data_arr.each_with_index do |entry, i|
+      last_col = entry[-1]
+      cols = entry[0].ljust(row_length - last_col.size)
+      tb_rows << "#{ol_prefix(i)}#{cols}#{last_col}"
+    end
+    tb_rows
+  end
+
+  # Helper: Ordered list prefix builder
+  # @param idx [Integer]
+  # @return [String]
+  def ol_prefix(idx) = "* [#{idx + 1}] - "
+
+  # Helper: Build horizontal line
+  # @param length [Integer]
+  # @return [String]
+  def horizontal_line(length) = "-" * length
+end