tiny_color 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb12cdf3f1fdc23d1f211194977b8743f38bb4acda953e5f86509d9dc67c4914
-  data.tar.gz: da092dc5141b66e86ca38cac7ac41b18788e54346a97b92ba591d7aefe76b92c
+  metadata.gz: d3fab6755d6cbd85d80d5b68ed03896947aef7c7c546b7f4178fa78f6ba44aee
+  data.tar.gz: ccb2c63c201a14635de641808c9ab34001a743468ec655a8efc29598572c3243
 SHA512:
-  metadata.gz: 82b177683f33c5292d420d1342a3351186679cecdcc5723cd2d194d545876e45ba2992daffa17f3e27b8ff47c150f920957fc1158fdd1e404ae517549f5a61d7
-  data.tar.gz: 5235f5ab444d167bb2fccfaa44187278a33ac05da835dfae7a0c2544413e45994bd57c4f5c8763c2cd8ab22b10475cf4228de7ed84f50235475a58351c4f681b
+  metadata.gz: cb4dc9ea78870716b1c21c8fafcf8c00addf14073e09833b94b7b7d5987912d26d8cba6c58eb93b59a80e4373fe4cda67b242c0f1ca7e43dee65023e65e26015
+  data.tar.gz: 9c36772323fe25ce70410486c6a93da391ba74c34fea346695de366258d208f9284bc847d0376b7dcaaf7cc02d518f631f119c9c772999a45caf666259ed0f8c

data/lib/tiny_color.rb

@@ -1,58 +1,73 @@
-# this code extends the String class, adding ANSI color codes for modifying the
-# text.
+# this class extends the String class to add color formatting methods using
+# ANSI escape codes.
 #
-# usage:
-#   puts 'Hi'.green + ' there!'
+# try these examples:
+#   require 'tiny_color'
 #
-#   "Hi there!"                             # where 'Hi' will appear in green,
-#                                           # and the rest in your # default
-#                                           # terminal color
+#   "Hello World!".red            # "Hello World!" in red
+#   "Hello World!".on_green       # "Hello World!" with green background
+#   "Hello World!".bold           # "Hello World!" in bold
+#   "Hello World!".underline      # "Hello World!" with underline
+#   "Hello World!".red.underline  # "Hello World!" with red color and underline
 #
-# you can also add background colors:
-#   puts 'Hi'.black.on_yellow + ' there!'
-#
-#   "Hi there!"                             # where 'Hi' will appear in black
-#                                           # with a yellow background, and the
-#                                           # rest in your default terminal
-#                                           # color
+# for support notes, see: https://en.wikipedia.org/wiki/ANSI_escape_code
 class String
   COLORS = {
     black:          30,
-    light_black:    90,
-
-    grey:           90,
-    gray:           90,
-
+    gray:           90, # convenient alias for light_black
+    grey:           90, # convenient alias for light_black
     red:            31,
-    light_red:      91,
-
     green:          32,
-    light_green:    92,
-
     yellow:         33,
-    light_yellow:   93,
-
     blue:           34,
-    light_blue:     94,
-
     purple:         35,
-    light_purple:   95,
-
     cyan:           36,
-    light_cyan:     96,
-
     white:          37,
+    light_black:    90,
+    light_red:      91,
+    light_green:    92,
+    light_yellow:   93,
+    light_blue:     94,
+    light_purple:   95,
+    light_cyan:     96,
     light_white:    97
   }
 
+  # see: https://en.wikipedia.org/wiki/ANSI_escape_code
+  # not all of these modes may be supported by your terminal
+  #
+  # some terminal emulators require that you enable certain features, such as
+  # blinking text
+  MODES = {
+    normal:           0,
+    bold:             1,
+    dim:              2,
+    italic:           3,
+    underline:        4,
+    blink:            5,
+    blink_slow:       5,
+    blink_fast:       6,
+    invert:           7,
+    hide:             8,
+    strike:           9,
+    double_underline: 20,
+    reveal:           28,
+    overlined:        53
+  }
+
   COLORS.each do |color, value|
     define_method color do
       "\033[#{value}m#{self}\033[0m"
     end
-
     define_method "on_#{color}" do
       "\033[#{value + 10}m#{self}\033[0m"
     end
   end
+
+  MODES.each do |mode, value|
+    define_method mode do
+      "\033[#{value}m#{self}\033[0m"
+    end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_color
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies: []
 description: a tiny library for String colorization
 email: jefflunt@gmail.com
@@ -39,6 +39,6 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
-summary: this is a minimalist library for colorinzing Strings, via extending the String
-  class
+summary: this is a minimalist library for adding color to Strings by extending the
+  String class
 test_files: []