cli_class_tool 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c961eaba9a0c3c12f12b82c9f7414e1f33370b242c73cab1f5d8d7d3f6459f6
-  data.tar.gz: 9ca127c47253b78a57908f55a2951d69c492f127fc45072927b13c935432c375
+  metadata.gz: 89e584d14bafdaf918d35406f8bf1dd1b548147cf65ff7e8a51f0f687add515c
+  data.tar.gz: 4dc4ed8c9a27d01fdf8b3cc408532b42e0c7ab2c80b6e75d92b35c1a200be4bb
 SHA512:
-  metadata.gz: ea040b33b39357299b3879dffdce2692ac97d8e90101c53344440642e3a11f73d9308161c70a15d265eef5ad6dd39ba115f7f9e00549941a53bc7a8a906a3a5f
-  data.tar.gz: 70436783a49a9cfb90a42ccdca5a0016954483b9a82b1df0db29e570c6416784c42c81c0e0746cfe11471442038021c0371987bfe5b01e04945f649d213c8849
+  metadata.gz: 52e76102055a0d40a7ef754232f30619a882b906200d29e7a31eafe87e24304225bc022877c3a504957389064874046ee522aba7d7e96d3dee46697d6e7afdaf
+  data.tar.gz: be038285b90077978d9b4f72150d66aee2d994f9dffa6b709b59c49b1be8a645a0fcfe1b9f6ca2e1cf9ffe372c1ad9832be7aa7ea026353c33084797e1bd1f3e

data/CHANGELOG

@@ -1,3 +1,10 @@
+------------------
+2.1.0  (2026-09-25)
+------------------
+
+* Add `String#hyperlink` method for OSC 8 terminal hyperlinks
+* Add `String#visible_length` method to compute visible string length stripped of ANSI escapes, control characters, and hyperlinks
+
 ------------------
 2.0.0  (2026-09-18)
 ------------------

data/README.md

@@ -488,3 +488,22 @@ puts "System Message".bold       # Bold text using default terminal color
 ```
 
 These methods automatically check if `$stdout` is a TTY and safely fall back to standard, unformatted strings if output is piped or redirected (non-TTY mode).
+
+### Terminal Hyperlinks (`hyperlink`)
+
+You can create clickable OSC 8 terminal hyperlinks using the `.hyperlink(url)` method. When `$stdout` is a TTY and a target URL is provided, it formats the string with OSC 8 escape sequences; otherwise, it returns the original string:
+
+```ruby
+puts "Visit Website".hyperlink("https://example.com")
+puts "Source Code".blue.hyperlink("https://github.com")
+```
+
+### Visible String Length (`visible_length`)
+
+To compute the display length of a string without ANSI color escape codes, embedded hyperlinks, or residual control characters, use `.visible_length`:
+
+```ruby
+str = "Click here".bold.red.hyperlink("https://example.com")
+str.length         # Raw string length including escape sequences
+str.visible_length # 10 (visible characters count)
+```

data/lib/cli_class_tool/string.rb

@@ -139,4 +139,28 @@ class String
     def light_white
         colorize(97)
     end
+
+    # Wrap the string in an OSC 8 terminal hyperlink if stdout is a TTY.
+    #
+    # @param url [String, #to_s, nil] Target URL for the hyperlink.
+    # @return [String] The formatted terminal hyperlink, or original string if not a TTY or URL is nil/empty.
+    def hyperlink(url)
+        @@is_a_tty = $stdout.isatty() if @@is_a_tty == nil
+        if @@is_a_tty && url && !url.to_s.empty?
+            "\e]8;;#{url}\e\\#{self}\e]8;;\e\\"
+        else
+            self
+        end
+    end
+
+    # Compute the visible length of the string
+    # Without any of ANSI/ASCII control characters nor embedded hyperlinks
+    #
+    # @return [Integer] Visible string length
+    def visible_length()
+        return self.gsub(/\e\]8;.*?(?:\e\\|\a)/, "") # Removes opening and closing hyperlink tags
+                   .gsub(/\e\[[0-9;?]*[a-zA-Z]/, "") # Removes ANSI escape codes (colors, cursor control)
+                   .gsub(/[[:cntrl:]]/, "")          # Removes any residual control characters
+                   .length
+    end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli_class_tool
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nicolas Morey
 bindir: bin
 cert_chain: []
-date: 2026-09-18 00:00:00.000000000 Z
+date: 2026-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake