just-ansi 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f93be0e88f2c592c08f145ee09ac614745333ecd14b9a9bb024c50adf3b2d549
-  data.tar.gz: daa92f7cb65f9ba56c5991ad2876f7aa4cc2738532dce52cf69ef25432a81275
+  metadata.gz: 4bc8e95b8442246c0bb54c0fc9fd4bbb0196023a254f0127cd77f1699c7af47d
+  data.tar.gz: de0c011547c12fdc2568233a17d40b0228ea4604f5114db02c860d67c0737ad9
 SHA512:
-  metadata.gz: 11c986e236eff5ef0ce7d815c39341dddb6050f8deec3e50df7a48fb45595d7ab722daa44c5b03d907e31332611fbe3099b05fd3c338c485bd54c00eb9713b31
-  data.tar.gz: d910ca7ac0374a2ab2237aa139e1e3cd5e1f29bfbf429ea6e65c7684d5d8932405f86ad5d8096961d59d7aa2bfccff8ac3215912681229b29507dfc502127e54
+  metadata.gz: 918be47dc5e4562af228c7a82e32713424fcd771cf78b174ae72fd8bfea37011af96a40b07564be935e4d28f25bb855d07a4db6cce058781b2a7ccc3998ad4f1
+  data.tar.gz: a908ba695fc54a3503e7faccab0fabeaded67385b3ff0a2a42ad7c12615ad6e2dc1aab81c8ca331d77bf040f417cd5f101181cf9d00cf08eb7577294b975a897

data/lib/just-ansi/attributes.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-# shareable_constant_value: literal
 
 module JustAnsi
   ATTRIBUTES = {
+    '/' => '',
     '/b' => '22',
     '/blink' => '25',
     '/bold' => '22',

data/lib/just-ansi/string.rb

@@ -2,7 +2,14 @@
 
 require_relative '../just-ansi'
 
+#
 # Ruby String class ANSI extension.
+#
+# This extension is not load by default but you need to require it.
+#
+# @example
+#   require 'just-ansi/string'
+#
 class String
   # Test if String contains ANSI codes.
   #
@@ -28,4 +35,37 @@ class String
   #
   # @return [String] string without ANSI attributes
   def unansi = JustAnsi.undecorate(self)
+
+  if defined?(:bbcode)
+    def bbcode = JustAnsi.bbcode(super)
+  else
+    # Replace embedded BBCode-like attributes with ANSI codes.
+    #
+    # @see JustAnsi.bbcode
+    #
+    # @return [String] string with ANSI attributes
+    def bbcode = JustAnsi.bbcode(self)
+  end
+
+  if defined?(:unbbcode)
+    def unbbcode = JustAnsi.unbbcode(super)
+  else
+    # Remove embedded BBCode-like attributes.
+    #
+    # @see JustAnsi.unbbcode
+    #
+    # @return [String] string without BBCode
+    def unbbcode = JustAnsi.unbbcode(self)
+  end
+
+  if defined?(:plain)
+    def plain = JustAnsi.plain(super)
+  else
+    # Remove any BBCode-like and/or ANSI attributes.
+    #
+    # @see JustAnsi.plain
+    #
+    # @return [String] string without BBCode and ANSI control codes.
+    def plain = JustAnsi.plain(self)
+  end
 end

data/lib/just-ansi/version.rb

@@ -2,5 +2,5 @@
 
 module JustAnsi
   # The version number of the gem.
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 end

data/lib/just-ansi.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# shareable_constant_value: literal
 
 #
 # Simple and fast ANSI control code processing.
@@ -187,6 +186,50 @@ module JustAnsi
       }m"
     end
 
+    # Replace embedded BBCode-like attributes with ANSI codes.
+    #
+    # @example
+    #   JustAnsi.bbcode "[b]Bold[/b] Text"
+    #   # "\e[1mBold\e[22m Text"
+    #
+    # @param str [#to_s] string to be modified
+    # @return [String] string with ANSI attributes
+    def bbcode(str)
+      str
+        .to_s
+        .gsub(BBCODE) do |match_str|
+          match = Regexp.last_match[1]
+          next "[#{match[1..]}]" if match[0] == '\\'
+          try_convert(match) || match_str
+        end
+    end
+
+    # Remove embedded BBCode-like attributes.
+    #
+    # @example
+    #   JustAnsi.unbbcode "[b]Bold[/b] Text"
+    #   # "Bold Text"
+    #
+    # @param str [#to_s] string to be modified
+    # @return [String] string without BBCode
+    def unbbcode(str)
+      str
+        .to_s
+        .gsub(BBCODE) do |match_str|
+          next match_str if (match = Regexp.last_match[1]).empty?
+          next "[#{match[1..]}]" if match[0] == '\\'
+          next match_str if (match = match.split).empty?
+          next if match.all? { ATTRIBUTES[_1] || COLORS[_1] || _color(_1) }
+          match_str
+        end
+    end
+
+    # Remove any BBCode-like and/or ANSI attributes.
+    #
+    # @param str [#to_s] string to be modified
+    # @return [String] string without BBCode and ANSI control codes.
+    def plain(str) = unbbcode(str).gsub(TEST, '')
+
     # @!group Control functions
 
     # Move cursor given lines up.
@@ -334,7 +377,7 @@ module JustAnsi
     #
     # @param [String] title text
     # @return (see cursor_up)
-    def window_title(title) = "\e]2;#{title}\e\\"
+    def window_title(title) = "\e]2;#{title}\a"
 
     # Change tab title.
     # This is not widely supported.
@@ -345,7 +388,9 @@ module JustAnsi
 
     # Create a hyperlink.
     # This is not widely supported.
-    def link(url, text) = "\e]8;;#{url}\e\\#{text}\e]8;;\e\\"
+    def link(url, text) = "\e]8;;#{url}\a#{text}\e]8;;\a"
+
+    # @comment simple  def notify(title) = "\e]9;#{title}\a"
 
     # @!endgroup
 
@@ -403,15 +448,17 @@ module JustAnsi
   end
 
   TEST =
-    /\e
-      (?:\[[\d;:\?]*[ABCDEFGHJKSTfminsuhl])
+    /
+      (?:\e\[[\d;:\?]*[ABCDEFGHJKSTfminsuhl])
       |
-      (?:\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\))
+      (?:\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
     /x
 
+  BBCODE = /(?:\[((?~[\[\]]))\])/
+
   require_relative 'just-ansi/attributes'
   autoload :NAMED_COLORS, File.join(__dir__, 'just-ansi', 'named_colors')
-  private_constant :TEST, :NAMED_COLORS
+  private_constant :TEST, :BBCODE, :NAMED_COLORS
 
   # @!visibility private
   RESET = self[:reset].freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just-ansi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-14 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies: []
 description: 'Simple and fast ANSI control code processing.