ragnetto-console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9493996b7bfe01888c558ac3934500a36ed9dacef3c724cf38d857f841b297b9
+  data.tar.gz: 99cb2949d29d83cb68cedc6ccf9e4e859058d398777d211db3cd84c28f86702d
+SHA512:
+  metadata.gz: efc4d6e2a5e14e4d4fcab92e1f7928f7026b392189d3b43607d5b97bbaca6328680bb2db16b4b6ebdea86c20e4608127678248da6f1cfc9c479b2d709b15c4c2
+  data.tar.gz: ecac94ea8cb5b813f89274d0a31cf505d5145d7797ba3a1a7c6bd2b950fb6c8442b40fffc9f046d50017fddc76b992dc26ebd8e2ebfa8d7e89619f3176b37654

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ragnetto(R)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# 🕷️ ragnetto-console
+
+**Ragnetto-Console** is a lightweight Ruby utility for terminal manipulation using ANSI escape sequences
+
+It provides an easy-to-use interface for colors, cursor positioning, and non-blocking input handling.
+
+This module is part of the ragnetto software suite.
+
+
+---
+
+
+## 🚀 Features
+
+*   **ANSI Colors** : Full support for 16 foreground and background colors.
+*   **Cursor Control** : Move (X, Y), toggle visibility (ON/OFF), and change shapes (Block, Bar, Underline).
+*   **Advanced Input** : Read single keys immediately without pressing Enter (Non-blocking input) with or without Echo.
+*   **Cross-platform** : Support for Unix-like systems (Linux/macOS) and Windows (via PowerShell integration).
+*   **Terminal Info** : Auto-detect console width and height.
+
+
+---
+
+
+## 📦 Installation
+
+Install the module via [RubyGems](https://rubygems.org):
+
+```bash
+gem install ragnetto-console
+```
+
+Or add it to your `Gemfile`:
+
+```ruby
+gem 'ragnetto-console'
+```
+
+---
+
+
+## 🛠️ Quick Start
+
+```ruby
+require 'ragnetto-console'
+
+# Alias for convenience
+C = Ragnetto::Console
+
+# Clear screen and set window title
+C.clear
+C.title("Ragnetto-Console Demo")
+
+# Write colored text at specific coordinates (X, Y)
+C.write("Welcome to Ragnetto-Console!", "LIGHT_GREEN", "BLACK", 10, 5)
+
+# Read a key without waiting for Enter
+print "\nPress any key to exit... "
+$stdout.flush
+C.getkey
+
+# Reset terminal styles to default
+C.reset
+```
+
+---
+
+
+## 📖 API Reference
+
+| Function | Description |
+| :--- | :--- |
+| `console.clear()` | Clears the screen and resets the cursor to the home position. |
+| `console.backcolor()` | Set the background text color. |
+| `console.forecolor()` | Set the foreground text color. |
+| `console.cursor(state)` | Toggles cursor visibility. |
+| `console.caret(shape)` | Changes the cursor shape. |
+| `console.position(x, y)` | Moves the cursor to the specified coordinates. |
+| `console.write(text, [f], [b], [x], [y])` | Writes text with optional colors and coordinates. |
+| `console.getkey()` | Reads a single keypress immediately (No-echo). |
+| `console.putkey()` | Reads a single keypress and prints it (Echo). |
+| `console.title(text)` | Sets the terminal window title. |
+| `console.width()` | Returns the current terminal width. |
+| `console.height()` | Returns the current terminal height. |
+| `console.reset()` | Resets all styles, colors, and cursor states. |
+
+---
+## 💎 Constants
+
+### 🎨 Colors
+
+You can use these strings for foreground (`f`) and background (`b`) parameters:
+
+*   **Standard**: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE`
+*   **Bright**: `GRAY`, `LIGHT_RED`, `LIGHT_GREEN`, `LIGHT_YELLOW`, `LIGHT_BLUE`, `LIGHT_MAGENTA`, `LIGHT_CYAN`, `LIGHT_WHITE`
+
+### 🖱️ Caret Shapes
+
+Values for the `console.caret(shape)` function:
+
+
+| Constant | Description |
+| :--- | :--- |
+| `BLOCK_BLINK` | Blinking block cursor |
+| `BLOCK_STEADY` | Static block cursor |
+| `UNDERLINE_BLINK` | Blinking underline cursor |
+| `UNDERLINE_STEADY` | Static underline cursor |
+| `BAR_BLINK` | Blinking vertical bar |
+| `BAR_STEADY` | Static vertical bar |
+
+
+### ⚙️ States
+
+Values for `console.cursor(state)`:
+*   `1` or `"ON"`: Show cursor.
+*   `0` or `"OFF"`: Hide cursor.
+
+---
+
+
+## 📝 License
+
+Distributed under the MIT License. See LICENSE for more information.
+
+Author: [ragnetto-gab](https://github.com/ragnetto-gab) (Ragnetto®)
+
+E-Mail: [ragnettosoftware@gmail.com](mailto:ragnettosoftware@gmail.com)

data/lib/ragnetto/console/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ragnetto
+  module Console
+    VERSION = "0.1.0"
+  end
+end

data/lib/ragnetto/console.rb

@@ -0,0 +1,228 @@
+# ------------------------------------------------------------------------------
+#  Ragnetto-Console
+# ------------------------------------------------------------------------------
+#  File         : console.rb
+#  Description  : ANSI console control utility
+#  Language     : Ruby
+# ------------------------------------------------------------------------------
+#  Project      : ragnetto-console
+#  Author       : Gabriele Secci
+#  Editor       : Ragnetto(R) Software
+#  E-Mail       : ragnettosoftware@gmail.com
+# ------------------------------------------------------------------------------
+#  Notes
+#  - This module provides terminal manipulation functions.
+#  - It is part of the Ragnetto module suite.
+# ------------------------------------------------------------------------------
+#  Copyright (C) 2026 - All Rights Reserved
+# ------------------------------------------------------------------------------
+
+require_relative "console/version"
+
+module Ragnetto
+  module Console
+    # -----------------------------------------------------------------------------
+    #  CORE CONSTANTS
+    # -----------------------------------------------------------------------------
+
+    COLORS = {
+      "BLACK"         => 0,  "RED"           => 1,  "GREEN"         => 2,  "YELLOW"        => 3,
+      "BLUE"          => 4,  "MAGENTA"       => 5,  "CYAN"          => 6,  "WHITE"         => 7,
+      "GRAY"          => 8,  "LIGHT_RED"     => 9,  "LIGHT_GREEN"   => 10, "LIGHT_YELLOW"  => 11,
+      "LIGHT_BLUE"    => 12, "LIGHT_MAGENTA" => 13, "LIGHT_CYAN"    => 14, "LIGHT_WHITE"   => 15
+    }.freeze
+
+    STATE = {
+      "OFF" => 0,
+      "ON"  => 1
+    }.freeze
+
+    SHAPES = {
+      "BLOCK_BLINK"  => 1,
+      "BLOCK_STEADY" => 2,
+      "UNDERLINE_BLINK"  => 3,
+      "UNDERLINE_STEADY" => 4,
+      "BAR_BLINK"    => 5,
+      "BAR_STEADY"   => 6
+    }.freeze
+
+    # -----------------------------------------------------------------------------
+    #  CORE FUNCTIONS
+    # -----------------------------------------------------------------------------
+
+    # Clears the screen completely and resets the cursor
+    def self.clear
+      print "\e[2J\e[H"
+    end
+
+    # Set the background color (0-15)
+    def self.backcolor(color)
+      c = color.is_a?(String) ? COLORS[color.upcase] : color
+      return unless c
+
+      if c < 8
+        print "\e[#{40 + c}m"
+      else
+        print "\e[#{100 + (c - 8)}m"
+      end
+    end
+
+    # Set the text color (0-15)
+    def self.forecolor(color)
+      c = color.is_a?(String) ? COLORS[color.upcase] : color
+      return unless c
+
+      if c < 8
+        print "\e[#{30 + c}m"
+      else
+        print "\e[#{90 + (c - 8)}m"
+      end
+    end
+
+    # Manages the visibility of the cursor
+    def self.cursor(state)
+      s = state.is_a?(String) ? STATE[state.upcase] : state
+
+      if s == 1 || s == true || s.to_s.upcase == "ON"
+        print "\e[?25h"
+      else
+        print "\e[?25l"
+      end
+    end
+
+    # Change the shape of the cursor (Caret)
+    def self.caret(shape)
+      s = shape.is_a?(String) ? SHAPES[shape.upcase] : shape
+
+      print "\e[#{s} q" if s && s >= 1 && s <= 6
+    end
+
+    # Move the cursor to a specific position
+    def self.position(x, y)
+      print "\e[#{y};#{x}H"
+    end
+
+    # Writes text with attributes and positioning
+    def self.write(text, fore = nil, back = nil, x = nil, y = nil)
+      out = ""
+
+      out << "\e[#{y};#{x}H" if x && y
+
+      if back
+        c_back = back.is_a?(String) ? COLORS[back.upcase] : back
+        out << "\e[#{c_back < 8 ? 40 + c_back : 100 + (c_back - 8)}m" if c_back
+      end
+
+      if fore
+        c_fore = fore.is_a?(String) ? COLORS[fore.upcase] : fore
+        out << "\e[#{c_fore < 8 ? 30 + c_fore : 90 + (c_fore - 8)}m" if c_fore
+      end
+
+      out << text.to_s
+      out << "\e[0m"
+
+      print out
+    end
+
+    # Reads a single character without echoing
+    def self.getkey
+      if Gem.win_platform?
+        cmd = '[console]::ReadKey($true).KeyChar'
+        pipe = IO.popen(['powershell', '-Command', cmd], 'r')
+        char = pipe.read
+
+        pipe.close
+
+        char ? char.strip : ""
+      else
+        system("stty -icanon -echo")
+        char = $stdin.read(1)
+        system("stty icanon echo")
+
+        char
+      end
+    end
+
+    # Reads a single character and prints it to the screen
+    def self.putkey
+      char = ""
+
+      if Gem.win_platform?
+        cmd = '[console]::ReadKey($true).KeyChar'
+        begin
+          pipe = IO.popen(['powershell', '-Command', cmd], 'r')
+          raw_out = pipe.read
+
+          pipe.close
+
+          char = raw_out ? raw_out.gsub(/[\r\n]/, '') : ""
+
+          unless char.empty?
+            print char
+            $stdout.flush
+          end
+        rescue
+        end
+      else
+        system("stty -icanon -echo")
+        char = $stdin.read(1)
+        system("stty icanon echo")
+
+        if char && !char.empty?
+          print char
+          $stdout.flush
+        end
+      end
+
+      char
+    end
+
+    # Set the terminal window title
+    def self.title(title_text)
+      return unless title_text.is_a?(String)
+
+      print "\e]0;#{title_text}\a"
+    end
+
+    # Gets the current width of the console (columns)
+    def self.width
+      if Gem.win_platform?
+        pipe = IO.popen('powershell -command "$host.ui.rawui.WindowSize.Width"')
+        w = pipe.read.to_i
+        pipe.close
+        w.zero? ? 80 : w
+      else
+        pipe = IO.popen("stty size 2>/dev/null")
+        res = pipe.read
+        pipe.close
+        res.empty? ? 80 : res.split[1].to_i
+      end
+    rescue
+      80
+    end
+
+    # Gets the current height of the console (rows)
+    def self.height
+      if Gem.win_platform?
+        pipe = IO.popen('powershell -command "$host.ui.rawui.WindowSize.Height"')
+        h = pipe.read.to_i
+        pipe.close
+        h.zero? ? 24 : h
+      else
+        pipe = IO.popen("stty size 2>/dev/null")
+        res = pipe.read
+        pipe.close
+        res.empty? ? 24 : res.split[0].to_i
+      end
+    rescue
+      24
+    end
+
+    # Reset all styles to default values
+    def self.reset
+      print "\e[0m"
+      print "\e[?25h"
+      print "\e[0 q"
+    end
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: ragnetto-console
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriele Secci
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A pure Ruby module providing terminal manipulation functions. Part of
+  the Ragnetto module suite.
+email:
+- ragnettosoftware@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ragnetto/console.rb
+- lib/ragnetto/console/version.rb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.12
+specification_version: 4
+summary: ANSI console control utility in pure Ruby.
+test_files: []