chess_cli 0.9.2

data/lib/nimbus_file_utils/nimbus_file_utils.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "json"
+require "paint"
+
+# File operations helper module
+# @author Ancient Nimbus
+# @version 0.6.0
+module NimbusFileUtils
+  # Common reg pattern
+  # - :filename [String] Valid filename pattern
+  # - :digits [Regexp] Any digits
+  COMMON_REG = { filename: '[\sa-zA-Z0-9._-]+', digits: /\A\d+\z/, yesno: "(?<yes>yes|y)|(?<no>no|n)" }.freeze
+
+  class << self
+    attr_accessor :locale, :locale_filename
+
+    # Set program language
+    # @param lang [String] default to English(en)
+    # @param extname [String] default to `.yml`
+    def set_locale(lang = "en", extname: ".yml")
+      # localization target
+      @locale = lang
+      @locale_filename = formatted_filename(lang, extname)
+    end
+
+    # Return the root path.
+    # @return [String] project root path
+    def proj_root = @proj_root ||= File.expand_path("../..", __dir__)
+
+    # Return cross-system friendly filename.
+    # @param filename [String] file name
+    # @param extname [String] file extension name
+    # @return [String] Formatted filename
+    def formatted_filename(filename, extname = "")
+      raise ArgumentError, "Forbidden character detected" unless filename.match?(/\A[\sa-zA-Z0-9._-]+\z/)
+
+      filename.downcase.tr(" ", "_") + extname
+    end
+
+    # Return the full path of a specific file.
+    # @param filename [String]
+    # @param dirs [Array<String>] `filepath("en", ".config", "locale")` will return <root...>/.config/locale/en
+    # @return [String] full file path
+    def filepath(filename, *dirs) = File.join(proj_root, *dirs, filename)
+
+    # Check if a file exist in the given file path.
+    # @param filepath [String]
+    # @param use_filetype [Boolean]
+    # @param extname [String] file extension name
+    def file_exist?(filepath, use_filetype: true, extname: ".yml")
+      extname = "" unless use_filetype
+      filepath += extname
+      File.exist?(filepath)
+    end
+
+    # Returns a list of files within a given directory and file extensions
+    # @param folder_path [String] folder path
+    # @param extname [String] file extension name
+    # @return [Array<String>]
+    def file_list(folder_path, extname: ".yml")
+      filenames = []
+      Dir.new(folder_path).each_child { |entry| filenames << entry if File.extname(entry) == extname }
+      filenames
+    end
+
+    # Writes the given data and save it to the specified file path.
+    # @param filepath [String] The base path of the file to write (expects complete filepath with extension).
+    # @param data [Object] The data to serialize and write.
+    def write_to_disk(filepath, data)
+      extname = File.extname(filepath)
+      return "Operation error! File extension is missing." if extname.empty?
+
+      File.open(filepath, "w") do |output|
+        case extname
+        when ".yml" then output.puts data.to_yaml
+        when ".json" then output.puts JSON.pretty_generate(data)
+        else output.puts data
+        end
+      end
+    end
+
+    # Load file in YAML or JSON extension.
+    # @param filepath [String] the base path of the file to write (extension is added automatically).
+    # @param extname [String] set target file extension, default: `.yml`
+    # @param symbols [Boolean] set whether to use symbols as key, default: true
+    # @return [Hash]
+    def load_file(filepath, extname: ".yml", symbols: true)
+      raise ArgumentError, "Invalid extension: only .yml or .json is accepted" unless %w[.yml .json].include?(extname)
+
+      return puts "File not found: #{filepath}" unless File.exist?(filepath)
+
+      File.open(filepath, "r") do |file|
+        data = extname == ".yml" ? handle_yaml(file) : handle_json(file)
+        return symbols ? to_symbols(data) : data
+      end
+    end
+
+    # Retrieves a localized string by key path from the specified locale file.
+    # Returns a missing message if the locale or key is not found.
+    # @param key_path [String] e.g., "welcome.greeting"
+    # @param extname [String] set target file extension, default: `:yml`
+    # @return [String]
+    def get_string(key_path, extname: ".yml")
+      path = filepath(locale_filename, ".config", "locale")
+      @strings ||= load_file(path, extname: extname, symbols: false)
+
+      locale_strings = @strings[locale]
+      return "Missing locale: #{locale}" unless locale_strings
+
+      keys = key_path.to_s.split(".")
+      result = keys.reduce(locale_strings) do |val, key|
+        val&.[](key)
+      end
+
+      result || "Missing string: '#{key_path}'"
+    end
+
+    private
+
+    # Helper to handle yaml data
+    # @param file [File]
+    def handle_yaml(file)
+      YAML.safe_load(file, permitted_classes: [Time, Symbol], aliases: true, freeze: true)
+    rescue Psych::SyntaxError => e
+      puts "Textfile parsing error: '#{e.message}.'\nPlease verify the following file: \n#{File.path(file)}"
+      exit(1)
+    end
+
+    # Helper to handle json data
+    # @param file [File]
+    # @return [Hash]
+    def handle_json(file) = JSON.parse(file.read)
+
+    # Convert string keys to symbol keys.
+    # @param obj [Object]
+    # @return [Hash]
+    def to_symbols(obj)
+      case obj
+      when Hash then obj.transform_keys(&:to_sym).transform_values { |v| to_symbols(v) }
+      when Array then obj.map { |e| to_symbols(e) }
+      else obj
+      end
+    end
+  end
+
+  # Build a list of files with last modified date as metadata field
+  # @param folder_path [String] folder path
+  # @param filenames [Array<String>] filenames within the given directory
+  # @param col1 [String] header name for the file name col
+  # @param col2 [String] header name for the last modified name col
+  # @param list_width [Integer] the width of the table
+  # @return [Array<String>]
+  def build_file_list(folder_path, filenames, col1: "List of Files", col2: "Last modified date", list_width: 80)
+    file_list = file_list_head(col1:, col2:)
+    filenames.each_with_index do |entry, i|
+      prefix = "* [#{i + 1}] - "
+      filename = File.basename(entry, File.extname(entry)).ljust(list_width * 0.6 - (prefix.size % 8))
+      mod_time = File.new(folder_path + entry).mtime.strftime("%m/%d/%Y %I:%M %p")
+      file_list.push("#{prefix}#{filename} | #{mod_time}")
+    end
+    file_list
+  end
+
+  # Retrieves a localized string and perform String interpolation and paint text if needed.
+  # @param key_path [String] textfile keypath
+  # @param subs [Hash] `{ demo: ["some text", :red] }`
+  # @param paint_str [Array<Symbol, String, nil>]
+  # @param extname [String]
+  # @return [String, Array<String>] the translated and interpolated string
+  def s(key_path, subs = {}, paint_str: %i[default default], extname: ".yml")
+    str = NimbusFileUtils.get_string(key_path, extname: extname)
+    return str if str.is_a?(Array)
+
+    output = Paint % [str, *paint_str, subs]
+    paint_str.uniq.all?(:default) && subs.values.flatten[1..].nil? ? Paint.unpaint(output) : output
+  end
+
+  # Textfile strings fetcher
+  # @param sub [String] sub-head
+  # @param keys [Array<String>] key
+  # @return [Array<String>] array of textfile strings
+  def tf_fetcher(sub, *keys, root: "") = keys.map { |key| s("#{root}#{sub}#{key}") }
+
+  private
+
+  # Helper: Build the header for file list
+  # @param col1 [String]
+  # @param col2 [String]
+  # @param list_width [Integer]
+  # @return [Array<String>]
+  def file_list_head(col1:, col2:, list_width: 80) = ["#{col1.ljust(list_width * 0.7)} | #{col2}", "-" * list_width]
+end

data/user_data/dummy_user.json

@@ -0,0 +1,124 @@
+{
+  "uuid": "9e39f092-534e-4dbb-ac3c-64846b78d727",
+  "username": "Dummy User",
+  "saved_date": "2025-08-25 17:18:33 +0100",
+  "appdata": {
+    "chess": {
+      "1": {
+        "event": "Dummy User vs Legal Mate",
+        "site": "Ruby Arcade Terminal Chess by Ancient Nimbus",
+        "date": "08/04/2025 06:37 PM",
+        "round": null,
+        "white": "Dummy User",
+        "black": "Legal Mate",
+        "result": null,
+        "mode": 1,
+        "moves": {
+          "1": [
+            "e4",
+            "e5"
+          ],
+          "2": [
+            "Nf3",
+            "Nc6"
+          ],
+          "3": [
+            "Bc4",
+            "d6"
+          ],
+          "4": [
+            "Nc3",
+            "Bg4"
+          ],
+          "5": [
+            "h3",
+            "Bh5"
+          ],
+          "6": [
+            "Nfxe5",
+            "Bhxd1"
+          ],
+          "7": [
+            "Bcxf7",
+            "Ke7"
+          ]
+        },
+        "white_moves": [
+          "e4",
+          "Nf3",
+          "Bc4",
+          "Nc3",
+          "h3",
+          "Nfxe5",
+          "Bcxf7",
+          "Nd5+"
+        ],
+        "black_moves": [
+          "e5",
+          "Nc6",
+          "d6",
+          "Bg4",
+          "Bh5",
+          "Bhxd1",
+          "Ke7"
+        ],
+        "fens": [
+          "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
+          "rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq - 0 1",
+          "rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq - 0 2",
+          "rnbqkbnr/pppp1ppp/8/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq - 1 2",
+          "r1bqkbnr/pppp1ppp/2n5/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R w KQkq - 2 3",
+          "r1bqkbnr/pppp1ppp/2n5/4p3/2B1P3/5N2/PPPP1PPP/RNBQK2R b KQkq - 3 3",
+          "r1bqkbnr/ppp2ppp/2np4/4p3/2B1P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 0 4",
+          "r1bqkbnr/ppp2ppp/2np4/4p3/2B1P3/2N2N2/PPPP1PPP/R1BQK2R b KQkq - 1 4",
+          "r2qkbnr/ppp2ppp/2np4/4p3/2B1P1b1/2N2N2/PPPP1PPP/R1BQK2R w KQkq - 2 5",
+          "r2qkbnr/ppp2ppp/2np4/4p3/2B1P1b1/2N2N1P/PPPP1PP1/R1BQK2R b KQkq - 0 5",
+          "r2qkbnr/ppp2ppp/2np4/4p2b/2B1P3/2N2N1P/PPPP1PP1/R1BQK2R w KQkq - 1 6",
+          "r2qkbnr/ppp2ppp/2np4/4N2b/2B1P3/2N4P/PPPP1PP1/R1BQK2R b KQkq - 2 6",
+          "r2qkbnr/ppp2ppp/2np4/4N3/2B1P3/2N4P/PPPP1PP1/R1BbK2R w KQkq - 3 7",
+          "r2qkbnr/ppp2Bpp/2np4/4N3/4P3/2N4P/PPPP1PP1/R1BbK2R b KQkq - 4 7",
+          "r2q1bnr/ppp1kBpp/2np4/4N3/4P3/2N4P/PPPP1PP1/R1BbK2R w KQ - 5 8",
+          "r2q1bnr/ppp1kBpp/2np4/3NN3/4P3/7P/PPPP1PP1/R1BbK2R b KQ - 6 8"
+        ]
+      },
+      "2": {
+        "event": "Dummy User vs Master Yo status-Checkmate",
+        "site": "Ruby Arcade Terminal Chess by Ancient Nimbus",
+        "date": "08/04/2025 06:37 PM",
+        "round": null,
+        "white": "Dummy User",
+        "black": "Master Yo",
+        "result": null,
+        "mode": 1,
+        "moves": {
+          "1": [
+            "f4",
+            "e5"
+          ],
+          "2": [
+            "g4",
+            "Qh4#"
+          ]
+        },
+        "white_moves": [
+          "f4",
+          "g4"
+        ],
+        "black_moves": [
+          "e5",
+          "Qh4"
+        ],
+        "fens": [
+          "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
+          "rnbqkbnr/pppppppp/8/8/5P2/8/PPPPP1PP/RNBQKBNR b KQkq - 0 1",
+          "rnbqkbnr/pppp1ppp/8/4p3/5P2/8/PPPPP1PP/RNBQKBNR w KQkq - 0 2",
+          "rnbqkbnr/pppp1ppp/8/4p3/5PP1/8/PPPPP2P/RNBQKBNR b KQkq - 0 2",
+          "rnb1kbnr/pppp1ppp/8/4p3/5PPq/8/PPPPP2P/RNBQKBNR w KQkq - 1 3"
+        ]
+      }
+    }
+  },
+  "stats": {
+    "launch_count": 374
+  }
+}

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: chess_cli
+version: !ruby/object:Gem::Version
+  version: 0.9.2
+platform: ruby
+authors:
+- Ancient Nimbus
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: whirly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: |
+  A colourful terminal Chess, support Smith & Algebraic Notation input.
+
+  Core feature:
+  - FEN session import / export
+  - PGN file export
+  - User Profile Management
+  - Multiple chess session per profile
+  - Input hot-swapping
+  - Session hot-swapping
+  - Chessboard customization
+email:
+- rb@ttfn.lol
+executables:
+- chess_cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".config/locale/debug_en.yml"
+- ".config/locale/en.yml"
+- bin/chess_cli
+- lib/chess_cli.rb
+- lib/console/console.rb
+- lib/console/wait_utils.rb
+- lib/console_game/base_game.rb
+- lib/console_game/chess/board.rb
+- lib/console_game/chess/game.rb
+- lib/console_game/chess/input/algebraic_notation.rb
+- lib/console_game/chess/input/chess_input.rb
+- lib/console_game/chess/input/smith_notation.rb
+- lib/console_game/chess/launcher.rb
+- lib/console_game/chess/level.rb
+- lib/console_game/chess/logics/display.rb
+- lib/console_game/chess/logics/endgame_logic.rb
+- lib/console_game/chess/logics/logic.rb
+- lib/console_game/chess/logics/moves_simulation.rb
+- lib/console_game/chess/logics/piece_analysis.rb
+- lib/console_game/chess/logics/piece_lookup.rb
+- lib/console_game/chess/pieces/bishop.rb
+- lib/console_game/chess/pieces/chess_piece.rb
+- lib/console_game/chess/pieces/king.rb
+- lib/console_game/chess/pieces/knight.rb
+- lib/console_game/chess/pieces/pawn.rb
+- lib/console_game/chess/pieces/queen.rb
+- lib/console_game/chess/pieces/rook.rb
+- lib/console_game/chess/player/chess_computer.rb
+- lib/console_game/chess/player/chess_player.rb
+- lib/console_game/chess/utilities/chess_utils.rb
+- lib/console_game/chess/utilities/fen_export.rb
+- lib/console_game/chess/utilities/fen_import.rb
+- lib/console_game/chess/utilities/load_manager.rb
+- lib/console_game/chess/utilities/pgn_export.rb
+- lib/console_game/chess/utilities/pgn_utils.rb
+- lib/console_game/chess/utilities/player_builder.rb
+- lib/console_game/chess/utilities/session_builder.rb
+- lib/console_game/chess/version.rb
+- lib/console_game/console_menu.rb
+- lib/console_game/game_manager.rb
+- lib/console_game/input.rb
+- lib/console_game/player.rb
+- lib/console_game/user_profile.rb
+- lib/nimbus_file_utils/nimbus_file_utils.rb
+- user_data/.keep
+- user_data/dummy_user.json
+- user_data/pgn_export/.keep
+homepage: https://github.com/AncientNimbus/rb-chess
+licenses:
+- BSD-3-Clause
+metadata:
+  changelog_uri: https://github.com/AncientNimbus/rb-chess/blob/main/CHANGELOG.md
+  documentation_uri: https://ancientnimbus.github.io/rb-chess/doc/
+  homepage_uri: https://github.com/AncientNimbus/rb-chess
+  source_code_uri: https://github.com/AncientNimbus/rb-chess
+  code_coverage_uri: https://ancientnimbus.github.io/rb-chess/coverage/#_AllFiles
+post_install_message: Thanks for installing Chess powered by Ruby Arcade!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: A colourful terminal Chess, support Smith & Algebraic input, FEN I/O, user
+  profile management and more.
+test_files: []